Nostr Docs

Comprehensive documentation site for the Nostr protocol — guides, NIPs, and developer resources

Project Overview

Nostr Docs is a comprehensive documentation site built to help developers understand and build on the Nostr decentralized social protocol. It covers everything from the fundamentals of how Nostr works to detailed developer guides for implementing NIPs (Nostr Implementation Possibilities).

The site is built with Astro Starlight, providing a fast, accessible, and search-optimized documentation experience with full-text search, dark mode, and a responsive sidebar navigation. Content is written in MDX, allowing interactive components alongside standard documentation.

Topics covered include keys and identity, how relays work, publishing your first note, NIP references, and practical development guides. The documentation aims to be the go-to resource for anyone building on Nostr, from beginners understanding the protocol to advanced developers implementing custom NIPs.

Technologies Used

AstroStarlightMDXCloudflare PagesTypeScript
View Live DemoView Source Code