docs: new Documentation

This commit is contained in:
Emerson Bottero
2022-10-15 00:50:57 -03:00
parent cbcf7f8a11
commit 0da56a1249
9 changed files with 47 additions and 22 deletions

21
.github/gh-pages-publish.yml vendored Normal file
View File

@@ -0,0 +1,21 @@
name: Build and Deploy Docs
on: [push]
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v3
- 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.
run: |
pnpm install
cd ./packages/mermaid
pnpm docs:bundle
- name: Deploy 🚀📕
uses: JamesIves/github-pages-deploy-action@v4.3.3
with:
branch: gh-pages # The branch the action should deploy to.
folder: packages/mermaid/docs/.vitepress/dist # The folder the action should deploy.

View File

@@ -5,12 +5,12 @@ on:
branches:
- develop
paths:
- 'packages/mermaid/src/docs/**/*'
- 'packages/mermaid/docs/**/*'
pull_request:
branches:
- develop
paths:
- 'packages/mermaid/src/docs/**/*'
- 'packages/mermaid/docs/**/*'
jobs:
spellcheck:
name: 'Docs: Spellcheck'
@@ -24,5 +24,5 @@ jobs:
node-version: '16'
- run: npm install -g cspell
name: Install cSpell
- run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress
- run: cspell --config ./cSpell.json "packages/mermaid/docs/**/*.md" --no-progress
name: Run cSpell

View File

@@ -39,4 +39,4 @@ jobs:
run: pnpm run lint
- name: Verify Docs
run: pnpm run docs:verify
run: cd .\packages\mermaid\ && pnpm run docs:verify