marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-18 23:09:49 +02: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

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.
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
````
````markdown
```note
Note content
```
@@ -44,11 +44,10 @@ Warning content
```danger
Danger content
```
````
```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).
@@ -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.
3. Make changes or add new documentation.
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: