From c64e2106cf4e79e86b53370544614d28621ab03d Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 15 Sep 2023 13:53:07 +0530 Subject: [PATCH 1/6] docs: Add LiveEditor Beta --- .github/ISSUE_TEMPLATE/bug_report.yml | 5 ++++- .github/ISSUE_TEMPLATE/config.yml | 5 ++++- README.md | 3 +++ README.zh-CN.md | 4 ++++ 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2f87cd60c4..3ae9a47248 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -17,6 +17,9 @@ body: - Use a clear and concise title - Fill out the text fields with as much detail as possible. - Never be shy to give us screenshots and/or code samples. It will help! + + There is a chance that the bug is already fixed in the latest version, but not released yet. + So please check in [Live Editor - Beta](https://beta.mermaid.live) before raising an issue. - type: textarea attributes: label: Description @@ -43,7 +46,7 @@ body: attributes: label: Code Sample description: |- - If applicable, add the code sample or a link to the [Live Editor](https://mermaid.live). + If applicable, add the code sample or a link to the [Live Editor - Beta](https://beta.mermaid.live). Any text pasted here will be rendered as a Code block. render: text - type: textarea diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 44b16532c9..bea20c8289 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -7,8 +7,11 @@ contact_links: url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE about: Join our Community on Slack for Help and a casual chat. - name: Documentation - url: https://mermaid-js.github.io + url: https://mermaid.js.org about: Read our documentation for all that Mermaid.js can offer. - name: Live Editor url: https://mermaid.live about: Try the live editor to preview graphs in no time. + - name: Live Editor - Beta + url: https://beta.mermaid.live + about: Try unreleased changes in the develop branch. diff --git a/README.md b/README.md index f844e2cb92..bbae0b8e4e 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ Generate diagrams from markdown-like text.

简体中文

+

+Live Editor Beta +



diff --git a/README.zh-CN.md b/README.zh-CN.md index 80e7155090..b6f24cee86 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -21,6 +21,10 @@ Mermaid English

+

+Live Editor Beta +

+

From ab7fcb26d77618f2de33b9deafa828b00a5696c2 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 22 Sep 2023 10:20:16 +0530 Subject: [PATCH 2/6] Update URLs. --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 7 +++++-- README.md | 2 +- README.zh-CN.md | 4 ++-- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3ae9a47248..0c52295a80 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,7 +19,7 @@ body: - Never be shy to give us screenshots and/or code samples. It will help! There is a chance that the bug is already fixed in the latest version, but not released yet. - So please check in [Live Editor - Beta](https://beta.mermaid.live) before raising an issue. + So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue. - type: textarea attributes: label: Description @@ -46,7 +46,7 @@ body: attributes: label: Code Sample description: |- - If applicable, add the code sample or a link to the [Live Editor - Beta](https://beta.mermaid.live). + If applicable, add the code sample or a link to the [Live Editor - Develop](https://develop.git.mermaid.live). Any text pasted here will be rendered as a Code block. render: text - type: textarea diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index bea20c8289..7e0c78ff1e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -12,6 +12,9 @@ contact_links: - name: Live Editor url: https://mermaid.live about: Try the live editor to preview graphs in no time. - - name: Live Editor - Beta - url: https://beta.mermaid.live + - name: Live Editor - Develop + url: https://develop.git.mermaid.live about: Try unreleased changes in the develop branch. + - name: Live Editor - Next + url: https://next.git.mermaid.live + about: Try unreleased changes in the next branch. diff --git a/README.md b/README.md index bbae0b8e4e..738c839087 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Generate diagrams from markdown-like text. 简体中文

-Live Editor Beta +Live Editor: Develop | Next


diff --git a/README.zh-CN.md b/README.zh-CN.md index b6f24cee86..4d4115a4e1 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -12,7 +12,7 @@ Mermaid

-Live Editor! +实时编辑器!

📖 文档 | 🚀 入门 | 🌐 CDN | 🙌 加入我们 @@ -22,7 +22,7 @@ Mermaid

-Live Editor Beta +实时编辑器: Develop | Next


From 60d0dba648150ddc957ff2f9a65c542fb402dbfb Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 22 Sep 2023 10:25:42 +0530 Subject: [PATCH 3/6] Print commit ref --- scripts/editor.bash | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/editor.bash b/scripts/editor.bash index 3ae51ed335..db898ff3e5 100755 --- a/scripts/editor.bash +++ b/scripts/editor.bash @@ -3,6 +3,8 @@ set -euxo pipefail pnpm build +echo "$COMMIT_REF" + # Clone the Mermaid Live Editor repository rm -rf mermaid-live-editor git clone --single-branch https://github.com/mermaid-js/mermaid-live-editor.git From 882350311b1a7bb5999e3b1b408b9380515a870e Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 22 Sep 2023 10:40:42 +0530 Subject: [PATCH 4/6] chore: Append commit hash to version --- scripts/editor.bash | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/scripts/editor.bash b/scripts/editor.bash index db898ff3e5..c1f3f51c83 100755 --- a/scripts/editor.bash +++ b/scripts/editor.bash @@ -1,9 +1,16 @@ #!/usr/bin/env bash set -euxo pipefail + +pushd packages/mermaid +# Append commit hash to version +jq ".version = .version + \"+${COMMIT_REF:0:7}\"" package.json > package.tmp.json +mv package.tmp.json package.json +popd + + pnpm build -echo "$COMMIT_REF" # Clone the Mermaid Live Editor repository rm -rf mermaid-live-editor From 4946813ac6ed578ac3a896d6852d241c9eb2a992 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Fri, 22 Sep 2023 10:47:06 +0530 Subject: [PATCH 5/6] chore: Build only mermaid --- scripts/editor.bash | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/editor.bash b/scripts/editor.bash index c1f3f51c83..8c1d4e2c6e 100755 --- a/scripts/editor.bash +++ b/scripts/editor.bash @@ -8,9 +8,9 @@ jq ".version = .version + \"+${COMMIT_REF:0:7}\"" package.json > package.tmp.jso mv package.tmp.json package.json popd - -pnpm build - +pnpm run -r clean +pnpm build:types +pnpm build:mermaid # Clone the Mermaid Live Editor repository rm -rf mermaid-live-editor From 095394dbef78f5a17863ea361faca7f90e33841f Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Sun, 24 Sep 2023 11:13:50 +0530 Subject: [PATCH 6/6] docs: Correct words Co-authored-by: Alois Klink --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- README.md | 2 +- README.zh-CN.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0c52295a80..bd9cfb2536 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -18,7 +18,7 @@ body: - Fill out the text fields with as much detail as possible. - Never be shy to give us screenshots and/or code samples. It will help! - There is a chance that the bug is already fixed in the latest version, but not released yet. + There is a chance that the bug is already fixed in the git `develop` branch, but is not released yet. So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue. - type: textarea attributes: diff --git a/README.md b/README.md index 738c839087..99e3b29c22 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Generate diagrams from markdown-like text. 简体中文

-Live Editor: Develop | Next +Try Live Editor previews of future releases: Develop | Next


diff --git a/README.zh-CN.md b/README.zh-CN.md index 4d4115a4e1..31eb5b1cae 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -22,7 +22,7 @@ Mermaid

-实时编辑器: Develop | Next +尝试未来版本的实时编辑器预览: Develop | Next