← Use Cases

API Documentation

Document your REST or GraphQL API with markdown. Code blocks, tables, and full-text search included.

Clean API reference

Markdown handles API documentation well. Fenced code blocks for request/response examples, tables for parameters, headings for endpoint grouping. GetPagemark renders all of it cleanly with syntax highlighting.

Organized by folder

Structure your API docs by resource. Each folder becomes a sidebar section. authentication/, users/, billing/ — your file structure is your navigation. No config needed.

Searchable

Every GetPagemark site has full-text search built in. Your users can find the endpoint they need with Ctrl+K. Titles, headings, and content are all indexed.

Versioning

Need docs for multiple API versions? Use branches. Point one site at the v1 branch, another at v2. Or use folders: v1/, v2/ in the same repo.

Example Structure

api-docs/
├── index.md
├── authentication.md
├── errors.md
├── users/
│   ├── list.md
│   ├── create.md
│   └── update.md
└── billing/
    ├── subscriptions.md
    └── invoices.md

Folder structure maps directly to sidebar navigation.

Ready to host your api documentation?

Connect a GitHub repo. Get a docs site in 2 minutes.

Get started free