History

Pat Hartl df45af54f2 Basic docs for package script type		2026-01-14 20:12:41 -06:00
..
blog	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
Documentation	Basic docs for package script type	2026-01-14 20:12:41 -06:00
src	Add release info for 2.0.0-rc1	2026-01-13 21:24:37 -06:00
static	Docs: versioning, customize homepage and theme, add logo	2026-01-11 22:30:59 -06:00
.gitignore	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
docusaurus.config.ts	Docs: versioning, customize homepage and theme, add logo	2026-01-11 22:30:59 -06:00
package-lock.json	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
package.json	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
README.md	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
sidebars.ts	Docs: versioning, customize homepage and theme, add logo	2026-01-11 22:30:59 -06:00
tsconfig.json	Move documentation to Docusaurus	2025-12-14 17:01:10 -06:00
versions.json	Docs: versioning, customize homepage and theme, add logo	2026-01-11 22:30:59 -06:00

Website

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

Installation

yarn

yarn start

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

yarn build

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

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> 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.