Watch

mirror of https://github.com/privkeyio/docs.git synced 2026-10-23 22:19:12 +00:00

Live at docs.privkey.io https://docs.privkey.io

bitcoin documentation nostr

Python 56.1%
CSS 32.2%
JavaScript 11.7%

Find a file

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
Kyle 🐆 370968e527 Add keep-node to the docs portal (#3 ) * Add keep-node to the docs portal * Add PR CI that builds the portal without deploying		2026-06-24 17:10:44 -04:00
.github/workflows	Add keep-node to the docs portal (#3 )	2026-06-24 17:10:44 -04:00
assets	Add wisp project (#1 )	2026-06-11 21:42:09 -04:00
theme	Use relative asset paths so the portal works at any base path	2026-06-10 14:57:48 -04:00
.gitignore	Add docs.privkey.io portal: mdBook aggregator with shared PrivKey theme	2026-06-10 14:48:51 -04:00
build.py	Use relative asset paths so the portal works at any base path	2026-06-10 14:57:48 -04:00
projects.json	Add keep-node to the docs portal (#3 )	2026-06-24 17:10:44 -04:00
README.md	Simplify README (#2 )	2026-06-13 19:28:48 -04:00

README.md

PrivKey Docs

Source for docs.privkey.io. Each project keeps its own mdBook in its own repo; build.py clones them, applies the shared theme, and deploys to GitHub Pages. Each lands at docs.privkey.io/<name>/.

Add a project

Add an entry to projects.json:

{
  "name": "relay",
  "repo": "https://github.com/privkeyio/relay",
  "ref": "main",
  "title": "Relay",
  "description": "One-line summary."
}

The repo just needs a book.toml and a docs/ directory with a SUMMARY.md (see privkeyio/keep). The theme is injected at build time, so project repos stay theme-free.

Develop

python3 build.py                          # needs python3 + mdbook on PATH
python3 -m http.server -d public 8000     # preview at localhost:8000

Deploy is automatic via .github/workflows/deploy.yml (on push, daily cron, or manual dispatch). Brand styling lives in theme/privkey.css and theme/privkey.js.