Update docs for 2.0.0 prep

This commit is contained in:
Charlie Laabs
2022-01-04 22:15:33 -06:00
parent fb2128b080
commit 947100282e
11 changed files with 306 additions and 189 deletions

33
.github/workflows/typedoc.yml vendored Normal file
View File

@@ -0,0 +1,33 @@
name: Publish Typedoc to Github Pages
on:
push:
branches:
- master
paths:
- Readme.md
- src/config/classes.ts
- .github/workflows/typedoc.yml
- package.json
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Node.js for use with actions
uses: actions/setup-node@v2
with:
node-version: 'lts/*'
cache: 'npm'
- name: NPM install
run: npm ci
# Runs a single command using the runners shell
- name: Build and lint
run: npm run docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs