From 91acb9063b2ae6e1edc014340cf0e0c2629cc810 Mon Sep 17 00:00:00 2001 From: Jordi Mallach Date: Wed, 8 Nov 2023 02:46:33 +0100 Subject: [PATCH] Add a reference to Mermaid 9.1.7 documentation HedgeDoc 1.9.x bundles Mermaid version 9.1.7, which is old enough that current Mermaid syntax will fail to render inside HedgeDoc notes. Add a pointer to Mermaid 9.1.7 docs, so users of the current stable HedgeDoc know what's actually supported. https://github.com/mermaid-js/mermaid/blob/v9.1.7/docs/n00b-gettingStarted.md Signed-off-by: Jordi Mallach --- public/docs/features.md | 3 +++ public/docs/release-notes.md | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/public/docs/features.md b/public/docs/features.md index c2896952..d99dbffb 100644 --- a/public/docs/features.md +++ b/public/docs/features.md @@ -334,6 +334,9 @@ gantt More information about **mermaid** syntax [here](https://mermaid-js.github.io/mermaid/) +This version of HedgeDoc bundles Mermaid 9.1.7. The documentation for this version can +be found [here](https://github.com/mermaid-js/mermaid/blob/v9.1.7/docs/n00b-gettingStarted.md). + #### Abc Music Notation ```abc diff --git a/public/docs/release-notes.md b/public/docs/release-notes.md index f06eebb1..79c0d68f 100644 --- a/public/docs/release-notes.md +++ b/public/docs/release-notes.md @@ -1,5 +1,10 @@ # Release Notes +## UNRELEASED + +### Enhancements +- Add a pointer to Mermaid 9.1.7 documentation, which is what HedgeDoc 1 supports. + ## 1.9.9 2023-07-30 HedgeDoc has a new slogan! See [our announcement](https://community.hedgedoc.org/t/and-the-new-slogan-is/) for the details.