History

Ryan Pandya 850149ebcb Initialize database. Document it. Hate life.		2024-10-04 23:39:04 -07:00
..
blog	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
docs/how-i-built-this	Initialize database. Document it. Hate life.	2024-10-04 23:39:04 -07:00
src	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
static	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
.gitignore	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
babel.config.js	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
docusaurus.config.ts	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
package-lock.json	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
package.json	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
README.md	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
sidebars.ts	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00
tsconfig.json	Add Docusaurus; start adding documentation. Also, have a duplicate git commit message for reasons.	2024-10-04 22:17:33 -07:00

README.md

Website

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

Installation

$ yarn

Local Development

$ 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.

Build

$ yarn build

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

Deployment

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.