marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-14 17:54:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Change yarn to pnpm

Browse Source
This commit is contained in:
Sidharth Vinod
2022-11-01 10:34:45 +05:30
parent 61b7033c65
commit 70ec91d0db
2 changed files with 34 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/intro/index.md
View File

@@ -256,10 +256,10 @@ Latest Version: <https://unpkg.com/browse/mermaid@8.8.0/>
To Deploy Mermaid: To Deploy Mermaid:
1. You will need to install node v16, which would have npm 1. You will need to install node v16, which would have npm
2. Download yarn using npm 2. Install mermaid
3. Enter the following command: `yarn add mermaid` - NPM: `npm i mermaid`
4. You can then add mermaid as a dev dependency using this command: - Yarn: `yarn add mermaid`
`yarn add --dev mermaid` - Pnpm: `pnpm add mermaid`
### [Mermaid API](../config/setup/README): ### [Mermaid API](../config/setup/README):
@@ -300,22 +300,26 @@ Don't hesitate to contact me if you want to get involved!
## For contributors ## For contributors
### Setup ### Requirements
```sh - [volta](https://volta.sh/) to manage node versions.
yarn install - [Node.js](https://nodejs.org/en/). `volta install node`
``` - [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
### Build ## Development Installation
```sh ```bash
yarn build:watch git clone git@github.com:mermaid-js/mermaid.git
cd mermaid
# npx is required for first install as volta support for pnpm is not added yet.
npx pnpm install
pnpm test
``` ```
### Lint ### Lint
```sh ```sh
yarn lint pnpm lint
``` ```
We use [eslint](https://eslint.org/). We use [eslint](https://eslint.org/).
@@ -324,7 +328,7 @@ We recommend you to install [editor plugins](https://eslint.org/docs/user-guide/
### Test ### Test
```sh ```sh
yarn test pnpm test
``` ```
Manual test in browser: open `dist/index.html` Manual test in browser: open `dist/index.html`

30
packages/mermaid/src/docs/intro/index.md
View File

@@ -168,10 +168,10 @@ Latest Version: [https://unpkg.com/browse/mermaid@8.8.0/](https://unpkg.com/brow
To Deploy Mermaid: To Deploy Mermaid:
1. You will need to install node v16, which would have npm 1. You will need to install node v16, which would have npm
2. Download yarn using npm 2. Install mermaid
3. Enter the following command: `yarn add mermaid` - NPM: `npm i mermaid`
4. You can then add mermaid as a dev dependency using this command: - Yarn: `yarn add mermaid`
`yarn add --dev mermaid` - Pnpm: `pnpm add mermaid`
### [Mermaid API](../config/setup/README): ### [Mermaid API](../config/setup/README):
@@ -212,22 +212,26 @@ Don't hesitate to contact me if you want to get involved!
## For contributors ## For contributors
### Setup ### Requirements
```sh - [volta](https://volta.sh/) to manage node versions.
yarn install - [Node.js](https://nodejs.org/en/). `volta install node`
``` - [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
### Build ## Development Installation
```sh ```bash
yarn build:watch git clone git@github.com:mermaid-js/mermaid.git
cd mermaid
# npx is required for first install as volta support for pnpm is not added yet.
npx pnpm install
pnpm test
``` ```
### Lint ### Lint
```sh ```sh
yarn lint pnpm lint
``` ```
We use [eslint](https://eslint.org/). We use [eslint](https://eslint.org/).
@@ -236,7 +240,7 @@ We recommend you to install [editor plugins](https://eslint.org/docs/user-guide/
### Test ### Test
```sh ```sh
yarn test pnpm test
``` ```
Manual test in browser: open `dist/index.html` Manual test in browser: open `dist/index.html`