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

chore: Update docs build vitepress command

Browse Source
This commit is contained in:
Sidharth Vinod
2022-10-29 01:14:11 +05:30
parent 8f5fe38212
commit fed32607de
3 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/gh-pages-publish.yml vendored
View File

@@ -18,12 +18,13 @@ jobs:
- name: Install deps - name: Install deps
run: pnpm install run: pnpm install
- name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built. - name: Install and Build 🔧
run: | run: |
cd ./packages/mermaid cd ./packages/mermaid
pnpm docs:bundle pnpm docs:build:vitepress
- name: Deploy 🚀📕 - name: Deploy 🚀📕
uses: JamesIves/github-pages-deploy-action@v4.3.3 uses: JamesIves/github-pages-deploy-action@v4.3.3
with: with:
branch: gh-pages # The branch the action should deploy to. branch: gh-pages
folder: packages/mermaid/src/docs/.vitepress/dist # The folder the action should deploy. folder: packages/mermaid/src/vitepress/.vitepress/dist

2
CONTRIBUTING.md
View File

@@ -80,7 +80,7 @@ $ pnpm docs:dev
You can now build and serve the documentation site: You can now build and serve the documentation site:
```sh ```sh
$ pnpm docs:bundle $ pnpm docs:build:vitepress
$ pnpm docs:serve $ pnpm docs:serve
``` ```

8
packages/mermaid/package.json
View File

@@ -34,10 +34,10 @@
"docs:code": "typedoc --plugin typedoc-plugin-markdown --readme none --githubPages false --hideBreadcrumbs --gitRemote disable --hideInPageTOC --namedAnchors --out src/docs/config/setup --entryPointStrategy expand src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup", "docs:code": "typedoc --plugin typedoc-plugin-markdown --readme none --githubPages false --hideBreadcrumbs --gitRemote disable --hideInPageTOC --namedAnchors --out src/docs/config/setup --entryPointStrategy expand src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup",
"docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts", "docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts",
"docs:verify": "ts-node-esm src/docs.mts --verify", "docs:verify": "ts-node-esm src/docs.mts --verify",
"docs:build:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress", "docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress",
"docs:dev": "pnpm docs:build:vitepress && vitepress dev src/vitepress", "docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress",
"docs:bundle": "pnpm docs:build:vitepress && vitepress build src/vitepress", "docs:dev": "pnpm docs:pre:vitepress && vitepress dev src/vitepress",
"docs:serve": "pnpm docs:build:vitepress && vitepress serve src/vitepress", "docs:serve": "pnpm docs:pre:vitepress && vitepress serve src/vitepress",
"release": "pnpm build", "release": "pnpm build",
"lint": "eslint --cache --ignore-path .gitignore . && pnpm lint:jison && prettier --check .", "lint": "eslint --cache --ignore-path .gitignore . && pnpm lint:jison && prettier --check .",
"lint:fix": "eslint --fix --ignore-path .gitignore . && prettier --write .", "lint:fix": "eslint --fix --ignore-path .gitignore . && prettier --write .",