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