Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document recommended file extension and MIME type docs #4485

Merged
merged 5 commits into from
Jun 13, 2023
Merged

Document recommended file extension and MIME type docs #4485

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
64558ff
strawman extension and mime type docs
bollwyvl Jun 12, 2023
a7b75d7
Update docs
bollwyvl Jun 12, 2023
e2a32e5
Update integrations.md per review
bollwyvl Jun 13, 2023
3e20a42
Update docs
bollwyvl Jun 13, 2023
921bbd1
Move filetype Recommendations to the top
sidharthv96 Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/ecosystem/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,14 @@ They also serve as proof of concept, for the variety of things that can be built
- [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io)
- [ui.mermaid(...)](https://nicegui.io/reference#mermaid_diagrams)
- [ui.markdown(..., extras=\['mermaid'\])](https://nicegui.io/reference#markdown_element)

## Recommendations

### File Extension

Applications that support editing and saving mermaid files are encouraged to use the `.mmd` file extension.

### MIME Type

While not officially recognized by the [IANA](https://www.iana.org/assignments/media-types/media-types.xhtml),
the recommended MIME type for mermaid media is `text/vnd.mermaid`.
11 changes: 11 additions & 0 deletions packages/mermaid/src/docs/ecosystem/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,14 @@ They also serve as proof of concept, for the variety of things that can be built
- [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io)
- [ui.mermaid(...)](https://nicegui.io/reference#mermaid_diagrams)
- [ui.markdown(..., extras=['mermaid'])](https://nicegui.io/reference#markdown_element)

## Recommendations

### File Extension

Applications that support editing and saving mermaid files are encouraged to use the `.mmd` file extension.
bollwyvl marked this conversation as resolved.
Show resolved Hide resolved

### MIME Type

While not officially recognized by the [IANA](https://www.iana.org/assignments/media-types/media-types.xhtml),
the recommended MIME type for mermaid media is `text/vnd.mermaid`.