clone

every nostr nip as a chapter of an illustrated, early-2000s printed game manual

main
nip.guide / README.md
README.md 1.3K source

Nostr Protocol Manual (nip.guide)

A complete dictionary of Nostr NIPs styled as an early-2000s printed game manual. 99 chapters, one per NIP, built as a fully static site in site/.

Authoring

  • STYLEGUIDE.md — the page authoring guide (STE prose, component catalog, skeleton). Exemplar page: site/nips/01.html.
  • manifest.json — NIP metadata (status, tags, dates). Source specs: source-nips/.

Checks and derived files

python3 qa.py                      # structural QA over all pages (run after any page edit)
python3 tools/build_nip_index.py   # regenerate site/assets/nip-index.json (WebMCP agent index)

Both must be run after adding or editing pages. qa.py must report ALL CLEAN before deploying.

Deploy

Hosting: Cloudflare Workers static assets, worker name nip-guide.

npx wrangler deploy