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

Fixed broken links and syntax in the document

Browse Source
This commit is contained in:
saowang
2020-09-07 14:02:09 +08:00
parent 6a1c88204a
commit 1f4be42b3f
21 changed files with 179 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/tutorials-and-community/development.md
View File

@@ -7,9 +7,18 @@ title: Development and Contribution
## Updating the documentation
Please continue writing documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs).
Please continue writing documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs). We publish documentation using GitHub Pages with [jekyll-rtd-theme](https://github.com/rundocs/jekyll-rtd-theme).
We publish documentation using GitHub Pages.
1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/)
2. Change into docs directory
```sh
make
```
3. Build the site and make it available on a local server
```sh
make server
```
4. Browse to [http://localhost:4000/mermaid/](http://localhost:4000/mermaid/)
### Questions and/or suggestions ?