getting-started
Installation
SKILL.md
@farming-labs/docs — Getting Started
Always consult the project docs (and /docs routes when available) for the latest API and examples.
@farming-labs/docs is a modern, flexible MDX-based documentation framework. Write markdown, get a polished docs site. Supported frameworks: Next.js, TanStack Start, Farm.js, SvelteKit, Astro, Nuxt.
Quick reference
CLI (see also the cli skill)
| Scenario | Command |
|---|---|
| Interactive init (existing or fresh) | npx @farming-labs/docs@latest init — first asks Existing project or Fresh project; then theme (or Create your own theme), entry path, etc. Prompts with a placeholder (e.g. docs, my-docs) accept Enter as default. |
| Add docs to existing app | Run init in project root; choose Existing project when prompted. |
| Start from scratch (bootstrap, no prompts) | npx @farming-labs/docs@latest init --template <next | tanstack-start | nuxt | sveltekit | astro> --name <project-name> |
| Add generated API reference during init | npx @farming-labs/docs@latest init --api-reference (optional --api-route-root <path>) |
| Upgrade docs packages | npx @farming-labs/docs@latest upgrade — auto-detects next, tanstack-start, nuxt, sveltekit, or astro; use --framework if detection is ambiguous. |