DocFX生成PDF文档

使用DocFX生成PDF文档,将在线文档转换为PDF离线文档。

关于DocFX的简单介绍使用DocFX生成文档

使用docfx 命令

1.下载

https://github.com/dotnet/docfx/releases

2.使用

创建初始项目

docfx init -q

此命令生成一个名为docfx_project的默认项目。

3.生成网站

docfx docfx_project\docfx.json --serve

现在你可以访问http://localhost:8080查看生成的网站。使用 -p 端口 可以指定端口。

生成PDF文档

 

安装wkhtmltopdf

下载地址：https://wkhtmltopdf.org/downloads.html

Windows (MSVC) 0.12.4 版本下载地址：

https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.4/wkhtmltox-0.12.4_msvc2015-win64.exe

下载好以后安装，安装完成，添加PATH

例如安装在 C:\Program Files\wkhtmltopdf\，在执行docfx之前设置可执行文件夹路径％PATH％：set PATH=%PATH%;C:\Program Files\wkhtmltopdf\bin。

也可以在环境变量中添加PATH。

添加用于PDF文档的toc.yml

toc.yml

- name: Articles
  href: ../articles/toc.yml
- name: Api Documentation
  href: ../api/toc.yml
- name: Another Api Documentation
  href: ../api-vb/toc.yml

 这里的 toc.yml 就相当于聚合了其他文件夹的toc.yml。默认来说每个文件夹的toc.yml 都会生成pdf文档。

在docfx.json 添加pdf部分

"pdf": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api/index.md",
          "api-vb/**.yml"
        ],
        "exclude": [
          "**/toc.yml",
          "**/toc.md"
        ]
      },
      {
        "files": [
          "articles/**.md",
          "articles/**/toc.yml",
          "toc.yml",
          "*.md"
        ],
        "exclude": [
          "**/bin/**",
          "**/obj/**",
          "_site_pdf/**",
          "**/toc.yml",
          "**/toc.md"
        ]
      },
      {
        "files": "pdf/toc.yml"
      }
    ],
    "resource": [
      {
        "files": [
          "images/**"
        ],
        "exclude": [
          "**/bin/**",
          "**/obj/**",
          "_site_pdf/**"
        ]
      }
    ],
    "overwrite": [
      {
        "files": [
          "apidoc/**.md"
        ],
        "exclude": [
          "**/bin/**",
          "**/obj/**",
          "_site_pdf/**"
        ]
      }
    ],
    "dest": "_site_pdf"
  }

pdf 部分跟build 部分类似。

执行 docfx 命令，在 _site_pdf  文件夹下就可以看到pdf 文档了。

示例下载：http://dotnet.github.io/docfx/tutorial/walkthrough/artifacts/walkthrough3.zip

 

http://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_generate_pdf.html