Quickstart
Edit, customize, and deploy your docs
Your docs are MDX files in a GitHub repo. Push a commit, and the site rebuilds automatically.
Edit a page
Open any .mdx file and start writing. MDX is Markdown with components baked in.
---
title: Authentication
description: API keys, OAuth tokens, and webhook signatures
---
## API Keys
Every request requires an API key in the `Authorization` header:
<CodeGroup>
```bash cURL
curl https://api.acme.com/v1/payments \
-H "Authorization: Bearer sk_live_abc123"
```
```javascript Node.js
const acme = new Acme('sk_live_abc123');
```
</CodeGroup>Add a new page
1
Create an MDX fileAdd a file anywhere in your project — for example, guides/webhooks.mdx.
2
Add it to navigationOpen docs.json and add the page path to a group:
{
"group": "Guides",
"pages": ["guides/webhooks"]
}3
Push to GitHubCommit and push. The site rebuilds in about 30 seconds.
Customize your site
Everything lives in docs.json:
| Setting | What it does |
|---|---|
name | Site name in the header |
colors | Brand colors (primary, light, dark) |
logo | Light and dark mode logos |
theme | Visual theme — jam, nebula, or pulsar |
navigation | Sidebar groups and page order |
navbar | Top nav links and buttons |
See the full configuration reference for every available field.
Use the CLI
# Install (pick one)
npm install -g jamdesk
brew install jamdesk/tap/jamdeskjamdesk dev # Local preview with hot reload
jamdesk validate # Check docs.json and frontmatter for errors
jamdesk broken-links # Find broken internal links