-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add vitepress documentation to GitHub pages (#22)
- Install Vitepress - Uninstall API-Extractor - Remove auto generated docs - Add action to publish documentation
- Loading branch information
Showing
44 changed files
with
793 additions
and
1,295 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 }} | ||
|
Oops, something went wrong.