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

Update docs

Browse Source
This commit is contained in:
nirname
2023-12-19 00:59:26 +00:00
parent 2705c0de03
commit 37829696d8
10 changed files with 924 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/contributing/documentation.md
View File

@@ -33,6 +33,11 @@ flowchart LR
source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"]
```
## Enable Github Actions
> **Warning**
> So as to allow automatic compilation of documentation pages you have to enable github actions on your fork first
## Running the Documentation Website Locally
**[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).**
@@ -47,8 +52,10 @@ pnpm --filter mermaid run docs:dev
or
cd packages/mermaid
pnpm docs:dev
```bash
cd packages/mermaid
pnpm docs:dev
```
**Docker**
@@ -58,39 +65,31 @@ Open <http://localhost:3333/> in your browser.
## Format
The documentation is written in Markdown.
The documentation is written in Markdown. To get acquainted with its syntax [see the GitHub Markdown help page](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
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.
> **‼️ Danger**
> Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
````markdown
```note
Note content
This is a note
```
```tip
Tip content
This is a tip
```
```warning
Warning content
This is a warning
```
```danger
Danger content
This is a danger alert
```
````
Markdown is used to format the text, for more information about Markdown [see the GitHub Markdown help page](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
_\[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.
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 from the branch of your fork.
## Documentation organization: Sidebar navigation
If you want to propose changes to how the documentation is _organized_, such as adding a new section or re-arranging or renaming a section, you must update the **sidebar navigation.**