From 921bbd1a9f8043f97ddda39eea1d12dd39776196 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Tue, 13 Jun 2023 21:19:01 +0530 Subject: [PATCH] Move filetype Recommendations to the top --- docs/ecosystem/integrations.md | 25 +++++++++++-------- .../src/docs/ecosystem/integrations.md | 25 +++++++++++-------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/docs/ecosystem/integrations.md b/docs/ecosystem/integrations.md index 88d075f7e..28db3afff 100644 --- a/docs/ecosystem/integrations.md +++ b/docs/ecosystem/integrations.md @@ -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`. diff --git a/packages/mermaid/src/docs/ecosystem/integrations.md b/packages/mermaid/src/docs/ecosystem/integrations.md index 8e062c10b..be229a8aa 100644 --- a/packages/mermaid/src/docs/ecosystem/integrations.md +++ b/packages/mermaid/src/docs/ecosystem/integrations.md @@ -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`.