History

Mendon Kissling 728228ad3a uvx-as-quickstart		2025-10-28 10:24:40 -04:00
..
docs	uvx-as-quickstart	2025-10-28 10:24:40 -04:00
pdf	flatten-pdf-tabs	2025-10-24 15:47:10 -04:00
src	Implement mermaid diagram additions	2025-10-27 10:23:33 -04:00
static	quickstart	2025-10-23 21:17:21 -04:00
.gitignore	move-folder-to-keep-private-and-add-scraper-to-gitignore	2025-10-20 16:44:39 -04:00
docusaurus.config.js	Improve docusaurus and mermaid diagrams working	2025-10-27 10:23:33 -04:00
package-lock.json	Improve docusaurus and mermaid diagrams working	2025-10-27 10:23:33 -04:00
package.json	Improve docusaurus and mermaid diagrams working	2025-10-27 10:23:33 -04:00
README.md	initial-build-no-errors	2025-09-18 13:24:41 -04:00
scraper.config.json	move-folder-to-keep-private-and-add-scraper-to-gitignore	2025-10-20 16:44:39 -04:00
sidebars.js	remove-tui-page-from-sidebars	2025-10-24 10:19:26 -04:00
VERSIONING_SETUP.md	docs-setup-versioning-but-dont-enable	2025-10-01 10:04:34 -04:00
yarn.lock	Improve docusaurus and mermaid diagrams working	2025-10-27 10:23:33 -04: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.