云端自留地

快速开始

这个模板不是拿来供起来看的。先让它在本地跑起来,再慢慢决定要不要把它变成真正的文档站。

别一上来就改一堆配置,最后连是哪一步炸的都不知道。先跑通,后装修,这是救命顺序。

你需要准备什么

  • Node.js:建议用新一点的版本,别拿远古运行时折磨自己。
  • pnpm:这个模板默认按 pnpm 走。
  • Git:不会 Git 也能看,但你迟早还是要会一点。
  • 一个还能打开的终端:这个要求已经很低了。

别急着部署

第一次改文档时,先在本地预览。能正常打开、侧栏没乱、页面没炸,再推到线上。省得自动构建给你当众表演红叉。

本地跑起来

拉代码

git clone https://github.com/CharyeahOwO/fumadocs-template.git
cd fumadocs-template

如果你已经有仓库了,就不用重复克隆,直接进目录就行。

安装依赖

pnpm install

依赖安装慢不一定是项目坏了,也可能只是网络又在发癫。先看报错,别立刻开始玄学删库。

启动开发服务器

pnpm dev

启动后打开终端里显示的地址。Next 默认通常是:

http://localhost:3000

文档页一般在:

http://localhost:3000/docs

改一页试试

先改 content/docs/getting-started/quick-start.mdx 这种无关痛痒的页面。

保存后浏览器应该会自动刷新。如果没有刷新,看看终端有没有报 MDX 语法错误。

目录大概长这样

content/docs/
├── index.mdx                 # 文档首页
├── meta.json                 # 顶层侧栏顺序
├── getting-started/          # 入门说明
├── components/               # 组件和写法示例
└── deployment/               # 部署相关

这个模板的重点在 content/docs。大多数时候,你只需要改这里,别没事冲进 app/ 里面乱拆。

改文档的最小动作

一篇页面通常长这样:

---
title: 页面标题
description: 页面描述,会出现在部分 UI 和 SEO 里
---

# 页面标题

这里写正文。

文件名决定路由,frontmatter 决定展示名。比如:

content/docs/getting-started/configuration.mdx

对应的访问路径就是:

/docs/getting-started/configuration

如果你只想先写内容

那就记住三件事:

  1. 新页面放进 content/docs
  2. 页面开头写 frontmatter。
  3. 如果要控制侧栏顺序,改同目录下的 meta.json

不用一开始就把架构想得很宏大。文档站最怕的不是“不够高级”,是页面空得像样板房。

下一步

先把内容写出来,再谈审美。没内容的漂亮文档站,本质就是精装毛坯。

本页目录