d428d734c6* sidebars * init * more-content * backend-only-dockerfile * more-content * postgres-page * cleanup * cleanup * multiple-postgres-db * move-content * test * spacing-issue * remove-link-temporarily-for-build * code-review * add-note-for-readOnlyRootFilesystem * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * rename-concepts-to-overview * docs: Refactor deployment overview for clarity and conciseness * improve-sentence-add-comma-remove-trailing-spaces * code-review --------- Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| css | ||
| docs | ||
| i18n | ||
| src | ||
| static | ||
| .gitignore | ||
| .yarnrc.yml | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| index.d.ts | ||
| openapi.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| yarn.lock | ||
Website
This website is built using Docusaurus 3, a modern static website generator.
Installation
$ yarn install
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, including yarn serve.
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.