local_development.md

本地开发

运行本地服务

yarn install
yarn dev

Fumadocs 添加新书

文件	说明
README.md	添加新书链接
constants.ts	注册书名
contents/index.md	添加新书链接
contents/meta.json	注册新书目录
contents/<book>/index.md{,x}	新书首页
contents/<book>/meta.json	新书名、边栏目录
contents/<book>	新书内容
public/<book>	新书图片

手动更新 Orama 索引

export ORAMA_PRIVATE_API_KEY=<private-api-key>
export ORAMA_PRIVATE_INDEX=<private-index>
yarn build

Details

Nextra 添加新书

文件	说明
README.md	添加新书链接
pages/<book>/index.md{,x}	新书首页
pages/<book>/_meta.json	新书边栏目录
pages/<book>	新书内容
public/<book>	新书图片
_meta.json	注册新书目录
pages/index.md	添加新书链接
utils.ts	注册书名

注意

• 新书首页文件 index.md{,x} 要放在 pages/<book> 目录下，这样首页也会显示侧边栏。如果放在 pages 目录下，则侧边栏不会显示。这一点 Nextra 文档并未提到。可以参考 Nextra 文档 docs 主页的实际设置。
• 不要用纯数字作为章节文件的文件名（例如：1.md），否则 _meta.json 无法正确对章节进行排序，因为数字会被设别成 JSON object 成员序号。