Skip to content

Repository files navigation

BTCDecoded website

Static marketing site for btcdecoded.org, published to GitHub Pages from the docs/ directory.

What it is

  • Next.js 13 with output: "export" for a fully static build
  • Two entry paths after load: Developers (problem, architecture, Orange Paper, governance) and Nodes (why BLVM, pre-built packages, desktop downloads, FAQ)
  • MathJax on the Orange Paper page via better-react-mathjax
  • Assets live under public/ (e.g. public/assets/images/spec-map.jpg) and are served at /assets/... after export
  • public/llms.txt and public/robots.txt — machine-readable site index (llmstxt.org convention), copied to the site root on export

Install page (/install)

Structured fields (packages, managed-install previews, release links) come from data/install-content.json, consumed by pages/install.js (do not hand-edit release-driven values in JS).

Default build path: prebuild / preexport and CI run scripts/fetch-blvm-release.mjs, which refreshes data/install-content.json from the blvm GitHub Releases API (optional GITHUB_TOKEN; static/fallback if fetch is skipped). This keeps the marketing /install page aligned with shipped binaries. The mdBook chapter getting-started/installation.md is timeless and links here for downloads.

Commands

npm install
npm run fetch-blvm-release  # optional: same as prebuild — refresh data from GitHub releases
npm run dev            # http://localhost:3000
npm run export         # build → out/, copy to docs/, preserve CNAME + .nojekyll
npm run serve          # serve out/ on port 3000
npm run deploy         # export then gh-pages from docs/

Deploy

The export script runs next build, copies out/* into docs/, copies docs/CNAME when present, and writes docs/.nojekyll for GitHub Pages. Push docs/ on main (or your Pages branch) to publish.

Related

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages