Features

Everything InkLoom can do

The complete documentation platform for modern developer teams.

src/api/users.ts
export async function createUser(
data: CreateUserInput
): Promise<User>
AI generates docs
createUser — API Reference
Creates a new user account.
POST/api/v1/users
Parameters
dataCreateUserInput — required
AI Generation

AI Doc Generation

Generate comprehensive documentation from your codebase with a single command.

Your code already documents intent — InkLoom turns it into readable docs.

Pipeline passedmain · 2m ago
git push origin main
3 files changed
CI detects doc-relevant changes
src/api/users.ts matched
AI generates page updates
2 pages updated, 1 new
PR opened for review
#142 — Update API docs
Merged → deployed to edge
docs.acme.com — 1.2s
Evergreen Docs

Evergreen Documentation

A GitHub Action keeps your docs in sync with every commit, automatically.

Docs stay in sync with every commit, automatically.

Learn about Evergreen Docs →
main
3 commits ahead
InkLoom
GitHub
docs: update auth guide
2m ago
feat: add webhook docs
14m ago
fix: typo in quickstart
1h ago
GitHub Sync

GitHub Sync

Bidirectional sync between InkLoom and GitHub. Branch previews, PR-based reviews, edit anywhere.

Edit in InkLoom or push to Git — everything stays in sync.

Open
Update authentication guide#142
docs/auth-updatemain
authentication.mdx
-Use basic auth with your API key.
+Use Bearer tokens for API authentication.
+Include your token in the Authorization header.
2 approvals
Ready to merge
Branches & Reviews

Branches & Review Workflow

A full docs SDLC: create branches, open merge requests, assign reviewers, and merge with confidence.

Review documentation changes like you review code.

H2
Heading 2
B
I
U
S
Getting Started
Install the SDK and configure your project to start building.
npx create-inkloom@latest my-docs
Tip
You can also clone the starter template from GitHub.
Block Editor

Block Editor

A drag-and-drop block-based editor built for technical writing. Code blocks, callouts, tabs, embeds — no Markdown required.

Technical writing that feels natural, not like wrestling a text file.

GET/api/v1/usersList all users
Query Parameters
limitintegerMax results (default: 20)
offsetintegerPagination offset
statusstring"active" | "inactive"
Response200
{
"data": [{
"id": "usr_k9x...",
"email": "[email protected]"
}]
}
GETPOSTPUTDEL
API Reference

OpenAPI / API Reference

Drop in your OpenAPI spec and get fully interactive, auto-generated API reference docs.

API docs that are always accurate and always beautiful.

Terminal
$ inkloom deploy proj_abc --production
Deploying to production...
✓Building pages (24 pages)0.8s
✓Optimizing assets0.3s
✓Deploying to edge (300+ locations)1.1s
✓ Deployment complete
URL: https://docs.acme.com
ID: dep_7f3k9x · 2.2s total
CLI & API

CLI & API

Deploy from your terminal, script doc updates, and integrate into any CI/CD pipeline.

Automate documentation workflows however you want.

Light
Get started
Learn more
Dark
Get started
Learn more
Themes & Customization

Themes & Customization

Custom domains, brand colors, design tokens, and layout options to make your docs site feel like home.

Your docs, your brand — not ours.

Edge Deployment
All regions healthy
US East
12ms
48 nodes
EU West
18ms
36 nodes
AP South
24ms
28 nodes
300+
Edge locations
99.9%
Uptime SLA
<50ms
Avg response
Deployment & Hosting

Deployment & Hosting

One-click deploys to Cloudflare's edge network (300+ locations) or self-host on your own infrastructure.

Global performance with zero infrastructure work, or full control on your own servers.

Importing from Mintlify...Complete
Pages imported47 pages
Navigation preserved3 groups, 12 sections
Components convertedTabs, Callouts, Cards
URLs mappedAll redirects configured
Migration

Migration

One-click import from Mintlify and GitBook. Bring your pages, navigation, and metadata.

Switch platforms in minutes, not months.

Mintlify Alternative →GitBook Alternative →
A
M
J
3 editors online
Configure your API key in the dashboard settings.
The SDK supports both REST and GraphQL endpoints.
Ada
Authentication uses Bearer tokens by default
Max
J
Jamie2m ago
Should we mention the rate limit here?
Collaboration

Collaboration & Access

Real-time editing with live cursors, role-based access control, and inline comments.

Write together without stepping on each other's toes.

authenticat|
⌘K
AuthenticationGuides
Bearer token authentication
API KeysReference
Manage authentication keys
WebhooksGuides
Authenticate webhook payloads
SSO SetupEnterprise
SAML authentication configuration
Client-side search · No external service required
Search

Search

Client-side full-text search index built at deploy time. Fuzzy matching, keyboard nav, section-level results.

Your users find answers in milliseconds.

Ready to try it?

Start for freeView on GitHub