title	aliases
产品使用说明文档库

产品使用说明文档库

这个库托管了思码逸企业版所有的中文产品文档。

脚手架说明

1. 本仓库结构和功能借鉴自 TiDB 文档仓库
2. 本仓库内容通过 Merico 文档站仓库 展示，该仓库改造于 Pingcap 的 website-docs

生成 PDF

准备工作

1. 安装 python3（略）
2. 安装pandoc@1.19.1
3. 安装 MacTex （其他方案）
4. 安装字体 WenQuanYi Micro Hei Regular
5. 安装字体 WenQuanYi Micro Hei Mono Regular
6. 赋予权限 chmod a+x ./scripts/generate_pdf.sh

执行

在工程根目录执行以下两条命令：

合成各个页面到一个 markdown 文件里

python3 scripts/merge_by_toc.py

将 markdown 文件转为 pdf 文件

./scripts/generate_pdf.sh

注意 release_notes 文件夹

该目录下存放着思码逸企业版的发版说明文档，这些文档定期同步自飞书的发版说明文档，请勿手动修改

注意 TOC.md

1. 使用绝对路径作为链接地址

❌ - [关于思码逸](introduction/what_is_Merico.md)
✅ - [关于思码逸](/introduction/what_is_Merico.md)

2. 列表符号后只跟一个空格

❌ -    [关于思码逸](/introduction/what_is_Merico.md)
✅ - [关于思码逸](/introduction/what_is_Merico.md)

3. TOC 中的发版说明内容会自动更新，请勿手动修改发版说明内容（包括发版说明内容的注释行）