快速开始
Silen 将 Markdown 与 MDX 目录构建为服务端渲染的静态站点、本地搜索与确定性的 AI 可读产物。请使用 Node.js ^20.19.0 || >=22.12.0。
安装并激活
在项目根目录安装 Silen,然后激活 docs 目录:
pnpm add -D @aicode-nexus/silen
pnpm silen init docs
Silen 会自动安装所需的 react、react-dom 运行时以及 MDX 使用的 react/jsx-runtime,用户无需单独安装。
init 会创建 docs/.silen/config.ts 和 docs/index.mdx。它既适用于新目录,也适用于已有内容:只要目标文件已存在,Silen 就会报告冲突,不会覆盖你的内容。
本地开发
pnpm silen dev docs
编辑 docs/index.mdx,或增加 .md、.mdx 文件。目录树会直接形成路由,客户端导航无需整页刷新。本地搜索完全随站点运行,不需要托管搜索账号。
构建并检查
pnpm silen build docs
pnpm silen preview docs
默认输出到 docs/.silen/dist。构建结果包括完整 HTML,以及 llms.txt、llms-full.txt、ai-index.json 和干净 Markdown 路由。草稿页与设置了 ai: false 的页面不会进入 AI 产物。
明确部署边界
站点部署在子路径时设置 base;需要规范链接与站点地图时,将 siteUrl 设置为域名源:
export default defineConfig({
base: '/handbook/',
siteUrl: 'https://docs.example.com',
onBrokenLinks: 'error',
})