Skip to content

Commit

Permalink
docs: add vitepress documentation to GitHub pages (#22)
Browse files Browse the repository at this point in the history
- Install Vitepress
- Uninstall API-Extractor
- Remove auto generated docs
- Add action to publish documentation
  • Loading branch information
h2xd authored Jul 9, 2022
1 parent f108c07 commit 61f0926
Show file tree
Hide file tree
Showing 44 changed files with 793 additions and 1,295 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: 🚢 Deploy Docs

on:
push:
branches: [ main ]

jobs:
deploy:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [16]

steps:
- name: 👓 Checkout repository
uses: actions/checkout@v2

- name: 🚚 Setup pnpm
uses: pnpm/[email protected]
with:
version: 7.0.0

- name: 🔻 Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'pnpm'

- name: 📦 Install dependencies
run: pnpm install --filter './docs'

- name: 📃 Build Documentation
run: pnpm -r docs:build

- name: 🚢 Deploy to GitHub-Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/src/.vitepress/dist
9 changes: 6 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,15 @@ jobs:
matrix:
node-version: [16]
steps:
- uses: actions/checkout@v2
- uses: pnpm/[email protected]
- name: 👓 Checkout repository
uses: actions/checkout@v2

- name: 🚚 Setup pnpm
uses: pnpm/[email protected]
with:
version: 7.0.0

- name: Use Node.js ${{ matrix.node-version }}
- name: 🔻 Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
Expand Down
Loading

0 comments on commit 61f0926

Please sign in to comment.