Installation
create-tockdocs CLI
Create your docs directory
Use the create-tockdocs CLI to scaffold a new TockDocs project:
npx create-tockdocs my-docs
You can choose between two starter templates:
default— single-locale docs in legacy modei18n— multi-locale docs in legacy mode using@nuxtjs/i18n
# Create with the i18n starter
npx create-tockdocs my-docs -t i18n
Start the development server
Move into the project directory and start Nuxt in development mode:
cd my-docs
npm run dev
By default, TockDocs runs on http://localhost:4987.
4987 is already in use, the local dev launcher exits instead of falling back to 3000 or 3001.Start writing
Head over to the Edition guide to learn how content, routing, frontmatter, and MDC syntax work in TockDocs.
Which architecture do the starters use?
The generated starters are intentionally lightweight:
- the
defaultstarter uses legacy mode with a single content tree - the
i18nstarter uses legacy mode + i18n with locale folders such ascontent/enandcontent/zh
TockDocs also supports knowledge-base mode for multi-KB sites like the official docs. In that setup, content is organized under content/<kb>/<locale>/... with a kb.yml file per knowledge base.
AI Assistant Skill
Get started quickly with TockDocs by adding specialized knowledge to your AI assistant (Cursor, Claude, etc.):
npx skills add https://tockdocs.dev
This skill helps your assistant:
- scaffold pages with valid TockDocs structure
- use MDC and prose components correctly
- follow content and architecture conventions
- apply current TockDocs configuration patterns
Layer Integration
TockDocs is a Nuxt layer. The starter already generates a nuxt.config.ts that extends tockdocs:
export default defineNuxtConfig({
extends: ['tockdocs'],
})
In practice, you usually work through the standard Nuxt scripts from your app:
npm run dev
npm run build