The Pangolin docs site, built with Fumadocs on Next.js.
npm install
cp .env.example .env.local # optional: add an AI key
npm run dev # http://localhost:3000Other scripts: npm run build, npm start, npm run types:check.
The site works without an AI key. To enable the assistant, set one provider key in .env.local (ANTHROPIC_API_KEY, OPENAI_API_KEY, or GOOGLE_GENERATIVE_AI_API_KEY). See .env.example for model, OpenAI-compatible endpoint, and rate-limit options.
Readers can rate each page (👍/👎) and each AI answer. Every AI chat and every search-bar query (with its result count, so searches that found nothing stand out) is recorded so you can see what people look for.
- Storage: the docs server forwards events to the Fossorial API (
/api/v1/docs-analytics), which stores them in its Postgres and deletes anything older than 90 days. SetFOSSORIAL_API_URLandFOSSORIAL_API_KEY(the API'sAPI_KEY) (see.env.example); without them nothing is stored and the site works as usual. - Viewing:
analytics-dashboard/is a separate app that reads the API's database directly. See its README. - Readers are anonymous: votes carry a random id kept in the browser's localStorage, nothing else.
- Pages live in
content/docs/**/*.mdx. The URL is the file path. - The sidebar is defined in
lib/navigation.json. A page that isn't listed there is still published; it just doesn't appear in the sidebar. - Callouts and layout components (
Note,Info,Tip,Warning,Check,Card,CardGroup,Columns,Steps/Step,Tabs/Tab,Accordion/AccordionGroup,Expandable,ResponseField,Frame,Update) are implemented incomponents/mintlify.tsx. Icon names are mapped incomponents/icons.tsx. - Code blocks:
```yaml title="config.yml" {3-5}sets a title and highlights lines 3–5. To make tabbed code, put consecutive blocks withtab="Name"in a row. - Shared snippets live in
content/snippets/and are pulled in with<include>../../snippets/file.mdx</include>. - Images go in
public/images/and are referenced as/images/....