---
title: Hep.gg Docs (LLM)
description: Build and host Markdown documentation sites on Hep.gg, with a component kit, live preview, custom domains, and an AI editing API.
---

# Hep.gg Docs

Build and host documentation sites. Write Markdown, use the Hep.gg component kit,
preview live, publish to a hep.gg subdomain or a custom domain. Build by hand in
the dashboard or generate the whole site with an AI assistant via the editing API.

Dashboard: https://hep.gg/dashboard/pages
Tiers: free 2 sites; Hep.gg Prime 10 sites (+ stackable paid extra slots).

## Editor tabs
Content (file tree + Markdown editor + live preview), Appearance (theme + custom
CSS on Prime), Navigation (navbar, footer, home, SEO, redirects), Domains,
Search & Analytics, API & AI (editing keys).

## Content model
A site is a tree of Markdown pages plus optional category metadata.
- Doc page path: docs/<folder>/<name>, served at /docs/<folder>/<name>. First
  segment is always docs. Folders become sidebar categories.
- Standalone page path: pages/<name>, served at /<name>.
- Order in the sidebar from frontmatter sidebar_position (lower = higher).
  Category label/order set in the Navigation tab.
- Frontmatter fields: title, description, sidebar_label, sidebar_position
  (number), hide_title (bool), draft (bool). Write a description on every page;
  it powers search and the LLM index.
- Page format: mdx (default, components available) or md (plain CommonMark + GFM).
  Raw HTML/script, imports, exports, and {expression} braces are stripped.

## Components
Free: admonitions (note/tip/info/warning/caution/danger), Card/CardGrid (incl.
image cards), Endpoint, Method, Params/Param, CodeGroup, WhereItLives, Tabs/TabItem,
Steps/Step. Prime: Accordion/AccordionItem, Embed (URL videos/iframes), Callout
(custom colour). On a free site the Prime components render a small Prime notice.

## Images
No image uploads in this app. Reference images by URL; host them on the Hep.gg
uploader and paste the URL.

## Premium features
Custom domains, site search, full theme + custom CSS, removing the "Powered by
Hep.gg" footer, and the Prime component set require Hep.gg Prime.

## Footer
The footer copyright line supports a {{year}} token, replaced with the current
year at render time.

## AI editing API
Base URL: https://hep.gg/api/v1/pages
Auth: Authorization: Bearer <KEY>. Keys are scoped to one site, created in the
API & AI tab: one-off keys start dpk_ (expire ~1 hour, for a single session or
an assistant); long-lived keys start hepgg_docs_ (for scripts/CI).
Full authoring guide (components + content model + API): https://hep.gg/api/v1/pages/llms
Endpoints:
- GET /ai/site -> site summary + every page (path, title, format). Call first.
- GET /ai/page?path=docs/guides/install -> { path, format, frontmatter, body, llmBody }.
- PUT /ai/page (JSON { path, format, frontmatter, body, llmBody }) -> create or
  replace. path must start with docs/ or pages/, no extension. llmBody optional.
- DELETE /ai/page?path=docs/guides/old -> remove a page.
- POST /ai/category (JSON { path, label, position, collapsed }) -> set a folder's
  sidebar label/order.
Responses: { ok: true, data } or { ok: false, error, code }.