Update cli_install.md

This commit is contained in:
geekan 2024-02-01 10:21:58 +08:00 committed by GitHub
parent 90f84ad452
commit 026dd8167c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -33,11 +33,12 @@ # Step 3: Clone the repository to your local machine, and install it.
npm install @mermaid-js/mermaid-cli
```
- don't forget to the configuration for mmdc in config.yml
- don't forget to the configuration for mmdc path in config.yml
```yml
puppeteer_config: "./config/puppeteer-config.json"
path: "./node_modules/.bin/mmdc"
mermaid:
puppeteer_config: "./config/puppeteer-config.json"
path: "./node_modules/.bin/mmdc"
```
- if `pip install -e.` fails with error `[Errno 13] Permission denied: '/usr/local/lib/python3.11/dist-packages/test-easy-install-13129.write-test'`, try instead running `pip install -e. --user`
@ -61,7 +62,7 @@ # Step 3: Clone the repository to your local machine, and install it.
- **modify `config2.yaml`**
uncomment mermaid.engine from config2.yaml and change it to `playwright`
change mermaid.engine to `playwright`
```yaml
mermaid:
@ -91,7 +92,7 @@ # Step 3: Clone the repository to your local machine, and install it.
- **modify `config2.yaml`**
uncomment mermaid.engine from config2.yaml and change it to `pyppeteer`
change mermaid.engine to `pyppeteer`
```yaml
mermaid:
@ -100,8 +101,8 @@ # Step 3: Clone the repository to your local machine, and install it.
- mermaid.ink
- **modify `config2.yaml`**
uncomment mermaid.engine from config2.yaml and change it to `ink`
change mermaid.engine to `ink`
```yaml
mermaid:
@ -109,4 +110,4 @@ # Step 3: Clone the repository to your local machine, and install it.
```
Note: this method does not support pdf export.