nuke/docs
Xe Iaso 29622e605d
chore(docs): add link to status page in the footer (#814)
Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-07-12 13:32:24 -04:00
..
blog feat(blog): incident report for TI-20250709-0001 (#795) 2025-07-09 14:56:12 +00:00
docs chore(docs): fix typo in configuration/expressions (#811) 2025-07-11 13:30:27 +00:00
manifest chore(docs/manifest): branded 404 page 2025-07-09 17:06:23 -04:00
src docs: remove proof of work branding (#763) 2025-07-06 02:34:52 +00:00
static docs: add emma.pet sponsor 2025-07-06 14:25:27 +00:00
.dockerignore chore(docs): add fly.toml file as a hail mary 2025-07-10 06:05:17 -04:00
.gitignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
Dockerfile chore(docs): add fly.toml file as a hail mary 2025-07-10 06:05:17 -04:00
docusaurus.config.ts chore(docs): add link to status page in the footer (#814) 2025-07-12 13:32:24 -04:00
fly.toml chore(docs): add fly.toml file as a hail mary 2025-07-10 06:05:17 -04:00
package-lock.json chore: Remove unused/dead code (#703) 2025-06-25 09:31:33 -04:00
package.json feat(lib): use new challenge creation flow (#749) 2025-07-04 20:42:28 +00:00
README.md add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
sidebars.ts add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
tsconfig.json add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00

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.