Build Beautiful Docs From Markdown
A zero-config documentation generator with the Phosphor Terminal Noir theme. Write Markdown, get a polished dark-mode docs site with search, navigation, and rich components.
Overview
Phosphor is a system-wide CLI tool that turns a directory of Markdown files into a complete documentation website. Install it once, then run phosphor init in any project directory to scaffold a docs site. No frameworks, no bundlers, no configuration fatigue.
What You Get
Write documentation in standard Markdown with optional rich components. No proprietary format, no lock-in. Your content stays portable.
Every heading and paragraph is automatically indexed at build time. Users get fuzzy search with autocomplete, keyboard navigation, and zero JavaScript frameworks.
A dark theme designed for developer documentation. Monospace accents, syntax-colored terminals, dot-grid backgrounds, and smooth scroll spy.
Sidebar navigation collapses into a mobile drawer. Table of contents appears on wide screens. Everything adapts from phone to ultrawide.
Callouts, cards, terminal blocks, pipelines, decision grids, command references, and accordions. All via simple Markdown syntax.
Python 3 + PyYAML. No Node.js, no bundler, no build chain. One install, works everywhere.
How It Works
Quick Look
Phosphor is a system-wide CLI. After installing, run phosphor init inside any project directory to scaffold a docs site. It auto-detects your project name and GitHub URL from the git remote. The same polished theme works whether you're documenting a CLI tool, a library, or an internal system.
When To Use Phosphor
phosphor init in your project, edit pages, phosphor builddocs/ subdirectory, phosphor init docs/, build from therephosphor serve — auto-builds then starts a local server on port 8000_site/, push that directory to your gh-pages branchtheme/style.css in your phosphor-docs installationProject Structure
AI Agent Authoring
AI coding agents (Claude Code, Codex, Gemini CLI) can write phosphor documentation for any project. Point an agent at your codebase and tell it to create phosphor docs — it reads the project, understands the structure, and writes all the .md pages and docs.yaml config.
The phosphor-docs repo includes agent instruction files that teach any AI tool the full syntax:
CLAUDE.mdAGENTS.mdGEMINI.mdPHOSPHOR_AGENT.mdThe agent reference covers: complete docs.yaml config, all ::: component blocks, page structure rules, build commands, and common page patterns (homepage, reference, FAQ).