Name		Name	Last commit message	Last commit date
parent directory ..
docs		docs
src		src
static		static
.gitignore		.gitignore
README.md		README.md
docusaurus.config.ts		docusaurus.config.ts
package.json		package.json
sidebars.ts		sidebars.ts
tsconfig.json		tsconfig.json
typedoc.core-audio.json		typedoc.core-audio.json
typedoc.core-clock.json		typedoc.core-clock.json
typedoc.core-i18n.json		typedoc.core-i18n.json
typedoc.core-saves.json		typedoc.core-saves.json
typedoc.core.json		typedoc.core.json
typedoc.devtools.json		typedoc.devtools.json
typedoc.mdx-plugin.json		typedoc.mdx-plugin.json
typedoc.mdx.json		typedoc.mdx.json
typedoc.messenger.json		typedoc.messenger.json
typedoc.ui-i18n.json		typedoc.ui-i18n.json
typedoc.ui.json		typedoc.ui.json

README.md

Website

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

Installation

From the repository root:

bun install --frozen-lockfile

Local Development

bun run dev:docs

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

Build

bun run docs:build

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

Deployment

Deployment is handled by .github/workflows/docs.yml. For a manual Docusaurus deployment, run the workspace script through Bun:

bun run --cwd apps/docs 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.