From 64558ffa9cfcf951448202067d2a21d0d66fdc32 Mon Sep 17 00:00:00 2001 From: Nicholas Bollweg Date: Mon, 12 Jun 2023 09:09:29 -0500 Subject: [PATCH 1/5] strawman extension and mime type docs --- packages/mermaid/src/docs/ecosystem/integrations.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/packages/mermaid/src/docs/ecosystem/integrations.md b/packages/mermaid/src/docs/ecosystem/integrations.md index cd6f5058d..2e67600d9 100644 --- a/packages/mermaid/src/docs/ecosystem/integrations.md +++ b/packages/mermaid/src/docs/ecosystem/integrations.md @@ -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. + +### 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`. From a7b75d71e4da0846225b2fe6c87a3b9535204244 Mon Sep 17 00:00:00 2001 From: bollwyvl Date: Mon, 12 Jun 2023 14:14:19 +0000 Subject: [PATCH 2/5] Update docs --- docs/ecosystem/integrations.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/ecosystem/integrations.md b/docs/ecosystem/integrations.md index 24e3609d8..3b43c414a 100644 --- a/docs/ecosystem/integrations.md +++ b/docs/ecosystem/integrations.md @@ -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`. From e2a32e5040986b7da9b8a5d0d84f7aed5b519b5f Mon Sep 17 00:00:00 2001 From: Nicholas Bollweg Date: Tue, 13 Jun 2023 06:57:16 -0500 Subject: [PATCH 3/5] Update integrations.md per review --- packages/mermaid/src/docs/ecosystem/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/ecosystem/integrations.md b/packages/mermaid/src/docs/ecosystem/integrations.md index 2e67600d9..8e062c10b 100644 --- a/packages/mermaid/src/docs/ecosystem/integrations.md +++ b/packages/mermaid/src/docs/ecosystem/integrations.md @@ -204,7 +204,7 @@ They also serve as proof of concept, for the variety of things that can be built ### File Extension -Applications that support editing and saving mermaid files are encouraged to use the `.mmd` file extension. +Applications that support editing and saving mermaid files are encouraged to use `.mermaid` or `.mmd` file extensions. ### MIME Type From 3e20a42b3e2232a2ccd816e84496f5cc1692b159 Mon Sep 17 00:00:00 2001 From: bollwyvl Date: Tue, 13 Jun 2023 12:00:46 +0000 Subject: [PATCH 4/5] Update docs --- docs/ecosystem/integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ecosystem/integrations.md b/docs/ecosystem/integrations.md index 3b43c414a..88d075f7e 100644 --- a/docs/ecosystem/integrations.md +++ b/docs/ecosystem/integrations.md @@ -210,7 +210,7 @@ They also serve as proof of concept, for the variety of things that can be built ### File Extension -Applications that support editing and saving mermaid files are encouraged to use the `.mmd` file extension. +Applications that support editing and saving mermaid files are encouraged to use `.mermaid` or `.mmd` file extensions. ### MIME Type From 921bbd1a9f8043f97ddda39eea1d12dd39776196 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Tue, 13 Jun 2023 21:19:01 +0530 Subject: [PATCH 5/5] 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`.