Skip to content

Commit

Permalink
Docusaurus-powered documentation website (#1207)
Browse files Browse the repository at this point in the history
* add results of `npx @docusaurus/init@latest init ts-node classic`

* make screenshot look nice on dark themes via transparent background and outline

* customize website

* add gh workflow to publish the site

* fix the build

* change color palette to be TS-ey

* add square logo icon

* cleanup getting started page

* misc futzing

* tweak screenshot to trim border

* fix docusaurus config with proper url & baseurl

* fix screenshot on homepage

* add typedoc rendered to `./api` url

* marker internal helper functions as "internal"; they were showing up in typedoc

* writing out a bunch of docs pages

* homepage code cleanup

* fix workflow

* fix workflow

* fix workflow

* add "under construction" message

* fix readme link

* tweak docs; stop building on this topic branch

* update package-lock and tweak git user for publishing
  • Loading branch information
cspotcode committed Feb 10, 2021
1 parent 237ea5a commit b3b8573
Show file tree
Hide file tree
Showing 33 changed files with 11,770 additions and 1 deletion.
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.

0 comments on commit b3b8573

Please sign in to comment.