Features

All features to host, customize and ship agent-ready docs from public GitHub on docs.page.

Publish

Public GitHub hosting
Public GitHub hosting

Serve docs from a public GitHub repository on every push without any build or deploy step.

Components
Components

Use built-in MDX components for tabs, callouts, code blocks, and media. No imports needed.

Local preview
Local preview

Preview your theme and layout locally in the browser via the CLI before pushing to GitHub.

Branch preview
Branch preview

Preview any branch, commit, or pull request at a shareable ref URL before merging to main.

CLI
CLI

Scaffold projects, preview locally, check links, and manage docs agent from your terminal.

Organize

Sidebar
Sidebar

Define nested navigation groups and page links in docs.json, flat or keyed by each locale.

Tabs
Tabs

Split docs into top-level tabs, each with its own dedicated sidebar navigation tree.

Links
Links

Add icon shortcuts in the sidebar to internal pages or external destinations on your site.

Locales
Locales

Serve translated sidebars per locale from navigation configuration in your docs.json file.

Redirects
Redirects

Keep old URLs working when you move or rename pages anywhere across your public docs site.

Search
Search

Run full-text search across your docs site from the command palette with a built-in index.

Customize

Theme
Theme

Set light and dark mode, colors, fonts, and shadcn presets in docs.json on your docs site.

Logo
Logo

Set light and dark logos plus favicons for your docs site in docs.json configuration file.

Header
Header

Control the site header including name, theme toggle, GitHub link, and custom CTA buttons.

Social links
Social links

Show social profiles in the footer and Open Graph metadata in link previews for richer social sharing.

Vanity subdomains
Vanity subdomains

Host docs at owner subdomains on docs.page instead of the default repository URL path.

Custom domains
Custom domains

Map your own domain to a hosted docs site so readers see branded public URLs on your site.

Configure

Global variables
Global variables

Define reusable docs.json values and reference them in MDX with mustache placeholders.

Table of contents
Table of contents

Control which heading levels show in the on-page sidebar for every docs page on your site.

Previous and next links
Previous and next links

Show previous and next links at page bottoms in sidebar navigation order across your site.

Search engine indexing
Search engine indexing

Set seo.noindex in docs.json to block search engines from indexing your public docs site.

AI

llms.txt
llms.txt

Auto-generate llms.txt and llms-full.txt exports for LLM discovery and ingestion workflow.

MCP server
MCP server

Expose a per-repo MCP endpoint to list and read docs, toggled on or off in docs.json file.

Agent skills
Agent skills

Expose agent skills files as MCP resources so AI tools can read your hosted docs site.

Ask AI
Ask AI

Embed an in-docs AI chat panel with the agent block in docs.json. Available in beta.

Integrate

Analytics
Analytics

Add Google Analytics, Tag Manager, or Plausible without custom docs site template scripts.

GitHub App
GitHub App

Install the GitHub App for automatic PR comments with live docs preview links on every PR.

  • Components: MDX building blocks for page content
  • Reference: docs.json fields, CLI flags, and HTTP endpoints
  • Quickstart: get a live site in minutes