Files
Andrew BradleyandGitHub b8e671efba Docusaurus-powered documentation website (#1207)
* 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
2021-02-10 16:21:20 -05:00

745 B

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.