The source for mujina.org, the website of the Mujina open source Bitcoin mining firmware project. The site is built with VitePress and deployed to GitHub Pages. The miner firmware itself lives at https://github.com/256foundation/mujina.
You need Node.js and just.
just install # npm install
just dev # dev server with hot reload
Run just with no arguments to list the other recipes. Run just checks before you open a pull request; it builds the site and
fails on dead internal links.
- Pages are markdown, organized by Diataxis
mode:
tutorial/,howto/,reference/,explanation/.index.mdis the landing page;community.mdsits outside the modes. - Nav and sidebar:
.vitepress/config.mts. - Theme: CSS-only overrides in
.vitepress/theme/custom.css. - Images and other static assets:
public/.
Pull requests are welcome. CONTRIBUTING.md covers the workflow, commit atomicity, and message conventions. AGENTS.md records the site's content conventions: the organization, the prose register, and what the compatibility matrix may claim.
The hardware compatibility matrix depends on the community most of all: if you maintain a fork or a board driver, its row is yours to keep accurate.
.github/workflows/deploy.yml builds and deploys on push to
main. One workflow serves both cases: DOCS_BASE sets the base
path for fork previews, and the CNAME for mujina.org is emitted
only when building the production repository.