marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-14 12:59:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

update related /docs file

Browse Source
This commit is contained in:
Ashley Engelund (weedySeaDragon @ github)
2022-11-19 09:16:19 -08:00
parent bd8f620480
commit fee63d83ee
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/mermaid/src/docs/community/development.md
View File

@@ -239,12 +239,10 @@ We encourage contributions to the documentation at [mermaid-js/mermaid/src/docs]
- Documentation (we encourage updates to the `packages/mermaid/src/docs` folder; you can submit them via direct commits) - Documentation (we encourage updates to the `packages/mermaid/src/docs` folder; you can submit them via direct commits)
**_DO NOT CHANGE FILES IN `/docs`_** **_DO NOT CHANGE FILES IN `/docs`_**
The source files for documentation are in `/packages/mermaid/docs` and are written in markdown. The source files for documentation are in `/packages/mermaid/docs` and are written in markdown.
### The official documentation site ### The official documentation site
**[The mermaid documentation site](https://mermaid-js.github.io/mermaid/) is powered by [Vitepress](https://vitepress.vuejs.org/).** **[The mermaid documentation site](https://mermaid-js.github.io/mermaid/) is powered by [Vitepress](https://vitepress.vuejs.org/).**
@@ -257,7 +255,7 @@ Markdown is used to format the text, for more information about Markdown [see th
To edit Docs on your computer: To edit Docs on your computer:
_[TODO: need to keep this in sync with [check out a git branch in Contributing Code above](#1-checkout-a-git-branch) ]_ _[TODO: need to keep this in sync with [check out a git branch in Contributing Code above](#1-checkout-a-git-branch) ]_
1. Create a fork of the develop branch to work on. 1. Create a fork of the develop branch to work on.
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.