nuke/docs
Xe Iaso 93bfe910d8
docs(user/faq): clarify Anubis not being a cryptocurrency miner
Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-07-04 22:49:39 +00:00
..
blog docs(blog/v1.20.0): i am smart 2025-06-27 21:10:02 -04:00
docs docs(user/faq): clarify Anubis not being a cryptocurrency miner 2025-07-04 22:49:39 +00:00
manifest chore(docs/manifest): enable bbolt in an emptyDir 2025-07-04 21:07:37 +00:00
src fix(docs): make the docs respect light/dark mode (#334) 2025-04-23 04:01:02 +00:00
static docs: add BotStopper docs from the git repo (#752) 2025-07-03 23:09:45 +00:00
.dockerignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
.gitignore add docs site based on docusarus (#35) 2025-03-20 15:06:58 -04:00
Dockerfile Explicitely define image sources in Dockerfile (#21) 2025-03-20 17:28:30 -04:00
docusaurus.config.ts Add the blog section back (#670) 2025-06-16 09:28:21 -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.