Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docusaurus-powered documentation website #1207

Merged
merged 23 commits into from
Feb 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Publish website
on:
# branches pushed by collaborators
push:
branches:
- master
jobs:
build:
name: Build & Deploy
runs-on: ubuntu-20.04
steps:
# checkout code
- uses: actions/checkout@v2
# install node
- name: Use Node.js 14
uses: actions/setup-node@v1
with:
node-version: 14
# Render typedoc
- run: npm install && ./node_modules/.bin/typedoc
# Render docusaurus and deploy website
- run: |
set -euo pipefail
git config --global user.name "GitHub Action"
git config --global user.email "github-action@users.noreply.github.com"
cd website
yarn
yarn deploy
env:
GIT_USER: ${{ github.actor }}
GIT_PASS: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ tsconfig.schema.json
tsconfig.schemastore-schema.json
.idea/
/.vscode/
/website/static/api
180 changes: 180 additions & 0 deletions logo-icon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.