marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-23 10:16:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
nirname
2024-01-04 01:00:15 +00:00
parent a7d0d414b2
commit e2fd5ecd02
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/contributing/contributing.md
View File

@@ -312,13 +312,13 @@ To start working with the e2e tests:
**Host** **Host**
- Run `pnpm dev` to start the dev server - Run `pnpm dev` to start the dev server
- Start **Cypress** by running `pnpm cypress:open`. - Start **Cypress** by running `pnpm cypress:open`
**Docker** **Docker**
- Enable local connections for x11 server `xhost +local:` - Enable local connections for x11 server `xhost +local:`
- Run `./run pnpm dev` to start the dev server - Run `./run pnpm dev` to start the dev server
- Start **Cypress** by running `./run pnpm cypress:open --project .`. - Start **Cypress** by running `./run pnpm cypress:open --project .`
The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress. The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.
@@ -402,11 +402,6 @@ flowchart LR
source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"] 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 ### Running the Documentation Website Locally
**[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).** **[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).**
@@ -479,6 +474,13 @@ This is a danger alert
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**, which is defined in [the vitepress config](../.vitepress/config.ts). The same goes to **topbar**. 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**, which is defined in [the vitepress config](../.vitepress/config.ts). The same goes to **topbar**.
### Build Docs
The content of `/docs` folder is built with Github Actions.
> **Warning**
> So as to allow automatic compilation of documentation pages you have to enable Github Actions on your fork first
## Submit your pull request ## Submit your pull request
> **Note** > **Note**