Documentation
Everything you need to use Glyph or build extensions for it.
For readers
Install the app, add extensions, organize your library, read offline.
Getting Started
Install Glyph, add your first extension, and find your way around the app.
Library
Organize novels into folders, sort, badges, and import EPUB & PDF files.
Browse & Search
Discover novels across all installed sources, with per-source filters.
Reader
Reading modes, themes, fonts, bookmarks, brightness, search-in-chapter.
Downloads
Save chapters for offline reading. Per-novel, bulk, cancellable, storage controls.
Customization
App appearance, reader themes, importing .glyphtheme files.
Sync & Privacy
How iCloud sync works, incognito mode, content rating controls.
Insights
Reading streaks, monthly chapter counts, total time read, activity heatmap.
Troubleshooting
Common problems and fixes, extensions, sync, downloads, performance.
FAQ
General questions about Glyph, privacy, and how the app works.
Build an extension
From zero to a published source. Start here.
SDK Overview
Architecture, project layout, your first createSource() in TypeScript.
CLI Reference
Every glyph command, dev server, build, validate, test, add, logcat.
Rust Extensions
WIT bindings, the Guest trait, source.json, and current
limitations.
Publishing
Build, host on GitHub Pages, share a deep link, version updates.
Reference
Look up types, methods, and APIs while you build.
WIT Contract
The source-of-truth interface, what the host imports, what extensions export.
Source Interface
Required and optional methods, every type a source touches.
Capabilities
The six capability keys, auto-detection rules, manual Rust declaration.
HTTP & Requests
Synchronous HTTP, rate limiting, retries, cookies, error patterns.
Helpers & Utilities
HTML parsing, pagination, discover-section helpers, content-rating tagging.
Debugging
Network inspector, log streaming, common failures, playground tips.
Quick answers
Skip the prose, go straight to what you need.
- Start the dev server
npm run dev - Add a new source to a project
npx glyph add mysite - Add a Rust source
npx glyph add -l rust mysite - Test methods in a browser
npm run dev -- --open - Watch logs from your phone in the terminal
npx glyph logcat - Publish to GitHub Pages
npm run build - Search with filters
searchNovels(q, page, filters) - Declare what my source supports
capabilities: [...]