From 460ccd9b34476d8875a20a157172372478aef7aa Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 14:56:56 +0200 Subject: [PATCH 1/7] Added link to example --- docs/tutorials-and-community/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index d5281f2cd..6a02c7778 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -53,7 +53,7 @@ The docs are located in the `docs` folder and are written in MarkDown. Just pick **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them. -The contents of http://mermaid-js.github.io/mermaid/ are based on the docs from **Master** Branch. +The contents of [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch. ## How to Contribute to Docs From 8f438744cfbf5a2fdab51ff336475dc79abc4cf0 Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 14:58:58 +0200 Subject: [PATCH 2/7] Added link to example --- docs/tutorials-and-community/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index 6a02c7778..5628c02b3 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -121,7 +121,7 @@ Finally, if it is not in the documentation, no one will know about it and then * The docs are located in the docs folder and are ofc written in markdown. Just pick the right section and start typing. If you want to add to the structure as in adding a new section and new file you do that via the _navbar.md. -The changes in master is reflected in http://mermaid-js.github.io/mermaid/ once released the updates are commited to https://mermaid-js.github.io/#/ +The changes in master is reflected in [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to https://mermaid-js.github.io/#/ ### Questions and/or suggestions ? After logging in at [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22). From 7a7bad2aa314ea005e08b4b0f9be93e58c31f19d Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 14:59:31 +0200 Subject: [PATCH 3/7] Added link to example --- docs/tutorials-and-community/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index 5628c02b3..3c72076df 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -121,7 +121,7 @@ Finally, if it is not in the documentation, no one will know about it and then * The docs are located in the docs folder and are ofc written in markdown. Just pick the right section and start typing. If you want to add to the structure as in adding a new section and new file you do that via the _navbar.md. -The changes in master is reflected in [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to https://mermaid-js.github.io/#/ +The changes in master is reflected in [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to [https://mermaid-js.github.io/#/](https://mermaid-js.github.io/mermaid/#/). ### Questions and/or suggestions ? After logging in at [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22). From dfdae7f0467a9806869f78607adba5c6bfa3c04c Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:00:06 +0200 Subject: [PATCH 4/7] Added space --- docs/tutorials-and-community/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index 3c72076df..722b08839 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -14,7 +14,7 @@ Here are a few things to know to get you started on the right path. **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md)** -**Note:You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.** +**Note: You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.** ## Branching From 82ce848d24f8aee740b086f843971b2663730253 Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:32:59 +0200 Subject: [PATCH 5/7] Pointed Live editor and CLI to new repo --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 634d24609..5a6e26ac4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -196,8 +196,8 @@ To support mermaid on your website, all you have to do is add Mermaid’s JavaSc ## Examples can be found in [Getting Started](getting-started/n00b-gettingStarted.md) # Sibling projects -- [Mermaid Live Editor](https://github.com/mermaidjs/mermaid-live-editor) -- [Mermaid CLI](https://github.com/mermaidjs/mermaid.cli) +- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) +- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) - [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) From 005390f54b225247e064e2b4c08902fa9f034d8a Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:36:52 +0200 Subject: [PATCH 6/7] Updated http to https --- docs/tutorials-and-community/development.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index 722b08839..3e29b920c 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -53,7 +53,7 @@ The docs are located in the `docs` folder and are written in MarkDown. Just pick **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them. -The contents of [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch. +The contents of [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch. ## How to Contribute to Docs @@ -121,7 +121,7 @@ Finally, if it is not in the documentation, no one will know about it and then * The docs are located in the docs folder and are ofc written in markdown. Just pick the right section and start typing. If you want to add to the structure as in adding a new section and new file you do that via the _navbar.md. -The changes in master is reflected in [http://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to [https://mermaid-js.github.io/#/](https://mermaid-js.github.io/mermaid/#/). +The changes in master is reflected in [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) once released the updates are commited to [https://mermaid-js.github.io/#/](https://mermaid-js.github.io/mermaid/#/). ### Questions and/or suggestions ? After logging in at [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22). From cff55e91b0ab63f76024a8c59da4a1317e233ae9 Mon Sep 17 00:00:00 2001 From: Bastian Zimmermann <10774221+BastianZim@users.noreply.github.com> Date: Thu, 22 Oct 2020 15:41:36 +0200 Subject: [PATCH 7/7] Fixed bold --- docs/tutorials-and-community/development.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials-and-community/development.md b/docs/tutorials-and-community/development.md index 3e29b920c..4ebf23397 100644 --- a/docs/tutorials-and-community/development.md +++ b/docs/tutorials-and-community/development.md @@ -51,7 +51,7 @@ If it is not in the documentation, it's like it never happened. Wouldn't that be The docs are located in the `docs` folder and are written in MarkDown. Just pick the right section and start typing. If you want to propose changes to the structure of the documentation: -**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them. +**All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/assets/_sidebar.md). Click edit it to see them.** The contents of [https://mermaid-js.github.io/mermaid/](https://mermaid-js.github.io/mermaid/) are based on the docs from **Master** Branch.