快速入门
安装
开始使用 TockDocs。
create-tockdocs CLI
创建您的文档目录
使用 create-tockdocs CLI 快速搭建一个新的 TockDocs 项目：
Terminal
npx create-tockdocs my-docs
您可以选择两种起步模板：
default— 传统模式下的单语言文档i18n— 传统模式下使用@nuxtjs/i18n的多语言文档
Terminal
# 使用 i18n 模板创建
npx create-tockdocs my-docs -t i18n
启动开发服务器
进入项目目录并以开发模式启动 Nuxt：
Terminal
cd my-docs
npm run dev
默认情况下，TockDocs 运行在 http://localhost:4987。
如果端口
4987 已被占用，本地开发启动器会直接退出，而不会回退到 3000 或 3001。开始写作
前往 内容编辑 指南，了解 TockDocs 中的内容、路由、frontmatter 和 MDC 语法如何工作。
起步模板使用哪种架构？
生成的起步模板刻意保持轻量：
default模板使用 传统模式，包含单一内容树i18n模板使用 传统模式 + i18n，包含content/en和content/zh等语言文件夹
TockDocs 还支持 知识库模式，适用于像官方文档这样的多知识库站点。在此设置中，内容按 content/<kb>/<locale>/... 组织，每个知识库有一个 kb.yml 文件。
AI 助手技能
通过为您的 AI 助手（Cursor、Claude 等）添加专业知识，快速上手TockDocs：
Terminal
npx skills add https://tockdocs.vercel.app
此技能可帮助您的助手：
- 使用有效的 TockDocs 结构搭建页面
- 正确使用 MDC 和 prose 组件
- 遵循内容和架构规范
- 应用最新的 TockDocs 配置模式
层集成
TockDocs 是一个 Nuxt 层。起步模板已生成扩展 tockdocs 的 nuxt.config.ts：
nuxt.config.ts
export default defineNuxtConfig({
extends: ['tockdocs'],
})
实际工作中，您通常通过标准 Nuxt 脚本来操作您的应用：
Terminal
npm run dev
npm run build