nuke/docs
Xe Iaso 8b9dafac51
security: npm audit fix for GHSA-hfm8-9jrf-7g9w et. al (#1098)
* security: npm audit fix for GHSA-hfm8-9jrf-7g9w et. al

Closes #1097

I'm not sure that this is required, but I'd sleep better at night not
finding out that it is required the hard way.

Signed-off-by: Xe Iaso <me@xeiaso.net>

* chore: bump postcss version

Signed-off-by: Xe Iaso <me@xeiaso.net>

---------

Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-09-08 14:17:59 -04:00
..
blog fix(blog/cpu-core-odd): make the diagram look decent in light mode 2025-08-29 19:54:22 +00:00
docs feat: Warn on missing signing keys when persisting challenges (#1088) 2025-09-07 15:43:58 -04:00
manifest chore(docs): adjust anubis rules 2025-08-29 23:04:32 +00:00
src docs: remove proof of work branding (#763) 2025-07-06 02:34:52 +00:00
static chore(sponsors): add fabulous systems 2025-07-12 23:08:30 +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 security: npm audit fix for GHSA-hfm8-9jrf-7g9w et. al (#1098) 2025-09-08 14:17:59 -04:00
package.json security: npm audit fix for GHSA-hfm8-9jrf-7g9w et. al (#1098) 2025-09-08 14:17:59 -04: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.