Terminal
Terminal/Skill
Guide for building Zudoku API docs sites and developer portals, with lookups checked against the installed Zudoku version.
By Zuplo
Works with
npx skills add zuplo/tools --skill zudoku-guideBuild beautiful API documentation sites and developer portals with Zudoku. This skill teaches you how to find current documentation and configure Zudoku projects.
Before writing any Zudoku code, check if the package is installed:
ls node_modules/zudoku/
| User Question | First Check | How To |
|---|---|---|
| "Create/install Zudoku project" | references/create-zudoku.md | Setup guide with CLI and manual steps |
| "How do I configure X?" | references/embedded-docs.md | Look up in node_modules/zudoku/ |
| "How do I use X?" (no packages) | references/remote-docs.md | Fetch from https://zudoku.dev/llms.txt |
| "I'm getting an error..." | references/common-errors.md | Common errors and solutions |
| "Upgrade from v0.x to v0.y" | references/migration-guide.md | Version upgrade workflows |
Embedded docs first (if package installed)
Look up current types and config options in node_modules. Example:
grep -r "ZudokuConfig" node_modules/zudoku/dist/
references/embedded-docs.mdSource code second (if package installed)
If you can't find what you need in the types, look directly at the source code:
# Check type definitions
cat node_modules/zudoku/dist/config.d.ts
references/embedded-docs.mdRemote docs third (if package not installed)
Fetch the latest docs from the Zudoku website:
https://zudoku.dev/llms.txt
references/remote-docs.mdZudoku uses a single configuration file (zudoku.config.ts or .tsx, .js, .mjs, .jsx) that controls structure, metadata, style, plugins, and routing.
import type { ZudokuConfig } from "zudoku";
const config: ZudokuConfig = {
navigation: [
{ type: "category", label: "Documentation", items: ["introduction"] },
{ type: "link", to: "api", label: "API Reference" },
],
apis: {
type: "file",
input: "./apis/openapi.yaml",
path: "/api",
},
docs: {
files: "/pages/**/*.{md,mdx}",
},
};
export default config;
Zudoku supports GitHub Flavored Markdown and MDX (JSX in Markdown). Features include:
Zudoku is extensible with plugin types:
Zudoku supports deployment to:
Build with npm run build → outputs to /dist.
Zudoku requires Node.js 22.7.0+ (or 20.19+).
The config file runs on both client and server at runtime. Never include secrets directly in zudoku.config.ts — they will be exposed to the client.
Common signs of issues:
What to do:
references/common-errors.mdAlways verify before writing code:
Check package installed
ls node_modules/zudoku/
Look up current API
references/embedded-docs.mdreferences/remote-docs.mdWrite code based on current docs
Test locally
npm run dev # http://localhost:3000
references/create-zudoku.mdreferences/embedded-docs.md - Start here if package is installedreferences/remote-docs.mdreferences/common-errors.mdreferences/migration-guide.md