marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-15 10:14:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixed docs according review

Browse Source 
Update docs
This commit is contained in:
Nikolay Rozhkov
2023-08-23 00:23:14 +03:00
parent 7b45dbea1a
commit cee2a458f1
10 changed files with 39 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/community/docker-development.md
View File

@@ -34,14 +34,14 @@ Then you **clone** a copy to your local development machine (e.g. where you code
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need. [Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
Optionally, to run GUI (Cypress) within Docker you will also need X11 server installed. Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
Maybe you already have it installed, so check it first: You might already have it installed, so check this by running:
```bash ```bash
echo $DISPLAY echo $DISPLAY
``` ```
If variable `$DISPLAY` is not empty, then it must be working. Otherwise install it. If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
## Setup and Launch ## Setup and Launch

7
docs/community/documentation.md
View File

@@ -42,7 +42,7 @@ flowchart LR
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box. You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly. Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
```` ````markdown
```note ```note
Note content Note content
``` ```
@@ -58,11 +58,10 @@ Warning content
```danger ```danger
Danger content Danger content
``` ```
```` ````
> **Note** > **Note**
> If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. > If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. In that case, your branch should be based on master, not develop.
We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs). We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs).
@@ -87,7 +86,7 @@ _\[TODO: need to keep this in sync with [check out a git branch in Contributing
2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory. 2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory.
3. Make changes or add new documentation. 3. Make changes or add new documentation.
4. Commit changes to your branch and push it to GitHub (which should create a new branch). 4. Commit changes to your branch and push it to GitHub (which should create a new branch).
5. Create a Pull Request of your fork. 5. Create a Pull Request from the branch of your fork.
To edit Docs on GitHub: To edit Docs on GitHub:

4
docs/community/questionsAndSuggestions.md → docs/community/questions-and-suggestions.md
View File

@@ -2,7 +2,7 @@
> >
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
> >
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/questionsAndSuggestions.md](../../packages/mermaid/src/docs/community/questionsAndSuggestions.md). > ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/questions-and-suggestions.md](../../packages/mermaid/src/docs/community/questions-and-suggestions.md).
# Questions or Suggestions? # Questions or Suggestions?
@@ -24,5 +24,3 @@ Feel free to add to the discussion on the issue or topic.
If you can't find anything that already addresses your question or suggestion, _open a new issue:_ If you can't find anything that already addresses your question or suggestion, _open a new issue:_
Log in to [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). Log in to [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).
## How to Contribute a Suggestion

15
docs/intro/index.md
View File

@@ -16,7 +16,14 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
<div class='badges'> <div class='badges'>
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_) [![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml)
[![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid)
[![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid)
[![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master)
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
[![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
[![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
</div> </div>
@@ -322,7 +329,6 @@ To Deploy Mermaid:
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) - [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) - [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
- [HTTP Server](https://github.com/TomWright/mermaid-server)
## Request for Assistance ## Request for Assistance
@@ -343,7 +349,9 @@ Don't hesitate to contact me if you want to get involved!
<div class='badges'> <div class='badges'>
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22)
[![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
[![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
</div> </div>
@@ -428,6 +436,7 @@ _Mermaid was created by Knut Sveidqvist for easier documentation._
.badges > p { .badges > p {
display: flex; display: flex;
} }
.badges > p > a { .badges > p > a {
margin: 0 0.5rem; margin: 0 0.5rem;
} }

2
packages/mermaid/src/docs/.vitepress/config.ts
View File

@@ -196,7 +196,7 @@ function sidebarCommunity() {
{ text: 'Contributing to Mermaid', link: '/community/development' }, { text: 'Contributing to Mermaid', link: '/community/development' },
{ text: 'Contributing Code', link: '/community/code' }, { text: 'Contributing Code', link: '/community/code' },
{ text: 'Contributing Documentation', link: '/community/documentation' }, { text: 'Contributing Documentation', link: '/community/documentation' },
{ text: 'Questions and Suggestions', link: '/community/questionsAndSuggestions' }, { text: 'Questions and Suggestions', link: '/community/questions-and-suggestions' },
{ text: 'Adding Diagrams', link: '/community/newDiagram' }, { text: 'Adding Diagrams', link: '/community/newDiagram' },
{ text: 'Security', link: '/community/security' }, { text: 'Security', link: '/community/security' },
], ],

2
packages/mermaid/src/docs/.vitepress/theme/redirect.ts
View File

@@ -49,7 +49,7 @@ const idRedirectMap: Record<string, string> = {
'more-pages': '', 'more-pages': '',
'n00b-advanced': 'config/n00b-advanced', 'n00b-advanced': 'config/n00b-advanced',
'n00b-gettingstarted': 'intro/n00b-gettingStarted', 'n00b-gettingstarted': 'intro/n00b-gettingStarted',
'n00b-overview': 'community/n00b-overview', 'n00b-overview': 'intro/n00b-gettingStarted',
'community/n00b-overview': 'intro/n00b-gettingStarted', 'community/n00b-overview': 'intro/n00b-gettingStarted',
'n00b-syntaxreference': 'intro/n00b-syntaxReference', 'n00b-syntaxreference': 'intro/n00b-syntaxReference',
newdiagram: 'community/newDiagram', newdiagram: 'community/newDiagram',

6
packages/mermaid/src/docs/community/docker-development.md
View File

@@ -28,14 +28,14 @@ Then you **clone** a copy to your local development machine (e.g. where you code
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need. [Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
Optionally, to run GUI (Cypress) within Docker you will also need X11 server installed. Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
Maybe you already have it installed, so check it first: You might already have it installed, so check this by running:
```bash ```bash
echo $DISPLAY echo $DISPLAY
``` ```
If variable `$DISPLAY` is not empty, then it must be working. Otherwise install it. If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
## Setup and Launch ## Setup and Launch

7
packages/mermaid/src/docs/community/documentation.md
View File

@@ -28,7 +28,7 @@ flowchart LR
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box. You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly. Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
```` ````markdown
```note ```note
Note content Note content
``` ```
@@ -44,11 +44,10 @@ Warning content
```danger ```danger
Danger content Danger content
``` ```
```` ````
```note ```note
If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. In that case, your branch should be based on master, not develop.
``` ```
We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs). We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs).
@@ -74,7 +73,7 @@ _[TODO: need to keep this in sync with [check out a git branch in Contributing C
2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory. 2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory.
3. Make changes or add new documentation. 3. Make changes or add new documentation.
4. Commit changes to your branch and push it to GitHub (which should create a new branch). 4. Commit changes to your branch and push it to GitHub (which should create a new branch).
5. Create a Pull Request of your fork. 5. Create a Pull Request from the branch of your fork.
To edit Docs on GitHub: To edit Docs on GitHub:

2
packages/mermaid/src/docs/community/questionsAndSuggestions.md → packages/mermaid/src/docs/community/questions-and-suggestions.md
View File

@@ -18,5 +18,3 @@ Feel free to add to the discussion on the issue or topic.
If you can't find anything that already addresses your question or suggestion, _open a new issue:_ If you can't find anything that already addresses your question or suggestion, _open a new issue:_
Log in to [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). Log in to [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).
## How to Contribute a Suggestion

15
packages/mermaid/src/docs/intro/index.md
View File

@@ -10,7 +10,14 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins
<div class='badges'> <div class='badges'>
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_) [![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml)
[![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid)
[![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid)
[![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master)
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
[![NPM](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
[![Twitter Follow](https://img.shields.io/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
</div> </div>
@@ -99,7 +106,6 @@ To Deploy Mermaid:
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) - [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) - [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
- [HTTP Server](https://github.com/TomWright/mermaid-server)
## Request for Assistance ## Request for Assistance
@@ -120,7 +126,9 @@ Don't hesitate to contact me if you want to get involved!
<div class='badges'> <div class='badges'>
[![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22)
[![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
[![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)
</div> </div>
@@ -205,6 +213,7 @@ _Mermaid was created by Knut Sveidqvist for easier documentation._
.badges > p { .badges > p {
display: flex; display: flex;
} }
.badges > p > a { .badges > p > a {
margin: 0 0.5rem; margin: 0 0.5rem;
} }