marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-21 16:29:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move filetype Recommendations to the top

Browse Source
This commit is contained in:
Sidharth Vinod
2023-06-13 21:19:01 +05:30
parent 3e20a42b3e
commit 921bbd1a9f
2 changed files with 28 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/ecosystem/integrations.md
View File

@@ -6,6 +6,20 @@
# Integrations
## Recommendations
### File Extension
Applications that support mermaid files [SHOULD](https://datatracker.ietf.org/doc/html/rfc2119#section-3) use `.mermaid` or `.mmd` file extensions.
### MIME Type
The recommended [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) for mermaid media is `text/vnd.mermaid`.
[IANA](https://www.iana.org/) recognition pending.
---
The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions within other applications.
They also serve as proof of concept, for the variety of things that can be built with mermaid.
@@ -205,14 +219,3 @@ 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 `.mermaid` or `.mmd` file extensions.
### 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`.

25
packages/mermaid/src/docs/ecosystem/integrations.md
View File

@@ -1,5 +1,19 @@
# Integrations
## Recommendations
### File Extension
Applications that support mermaid files [SHOULD](https://datatracker.ietf.org/doc/html/rfc2119#section-3) use `.mermaid` or `.mmd` file extensions.
### MIME Type
The recommended [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) for mermaid media is `text/vnd.mermaid`.
[IANA](https://www.iana.org/) recognition pending.
---
The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions within other applications.
They also serve as proof of concept, for the variety of things that can be built with mermaid.
@@ -199,14 +213,3 @@ 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 `.mermaid` or `.mmd` file extensions.
### 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`.