Skip to content

Commit 5e9d4ee

Browse files
committed
docs: 添加生成 PDF 格式离线文档说明
- 在 README.md 中添加了使用 Docfx生成本地离线文档和 PDF格式离线文档的说明 - 提供了具体的命令示例,方便用户操作
1 parent 9e6d3d2 commit 5e9d4ee

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ $ mdbook serve
3131

3232
为了能够运行这些示例,你必须要连接到网络;当然你可以离线阅读所有这些内容。
3333

34+
## 生成PDF格式的离线文档
35+
36+
兼容Docfx文档工具,可以使用 [Docfx](https://dotnet.github.io/docfx/index.html) 来生成本地离线文档,本项目已经添加docfx配置,不影响mdbook工具,可以直接使用下面的命令打开docfx生成的文档页面以及生成PDF格式离线文档(带目录的PDF文件)。
37+
```bash
38+
docfx docfx.json --serve -p 8900
39+
```
40+
3441
## 如何贡献
3542

3643
请查看 [CONTRIBUTING.md][how-to-contribute] 文件了解详细内容。

0 commit comments

Comments
 (0)