【DocFX文檔翻譯】演練3: 生成PDF文檔

演練3: 生成PDF文檔

完成了演練2: 為文檔網(wǎng)站添加API文檔 后秦躯,我們成功地創(chuàng)建了一個包含概念和API文檔的網(wǎng)站。 在本節(jié)中,我們將為這些文章生成PDF文件第焰。

完成了演練2以后, 我們的 D:\docfx_walkthrough\docfx_project 文件夾應(yīng)該是如下結(jié)構(gòu)(在 這里 下載代碼 ):

|- articles
|- images
|- src
|- src2
|- index.md
|- toc.yml
|- docfx.json

第0步. 安裝必備環(huán)境
我們需要 wkhtmltopdf 來生成 PDF. 下載 wkhtmltopdf 到本地目錄, 例如. E:\Program Files\wkhtmltopdf\, 使用命令 set PATH=%PATH%;E:\Program Files\wkhtmltopdf\bin 將執(zhí)行文件目錄添加 %PATH% 環(huán)境變量果录。

[!注意]
另外你可以使用 chocolatey 的命令 choco install wkhtmltopdf 直接安裝wkhtmltopdf上枕。這個操作在安裝過程中會自動添加執(zhí)行目錄到 %PATH% 環(huán)境變量。

第1步. 添加 toc.yml 指定 PDF生成

目前的設(shè)計是每個TOC文件生成一個對應(yīng)的PDF文件弱恒,TOC也被用作PDF的封面辨萍,所以我們在 pdf文件夾下面為pdf生成創(chuàng)建一個特定的toc.yml文件,使用TOC 包含 來包含其他TOC文件的內(nèi)容返弹。

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

第1步. docfx.json 文件中添加 pdf 配置節(jié)

參數(shù)類似 build 配置節(jié), 區(qū)別是使用不同的模板(內(nèi)置模板是pdf.default)锈玉,以及不同的輸出路徑。 每個TOC文件生成PDF文件時义起,我們也排除了TOC文件拉背。

...
  "pdf": {
    "content": [
      {
        "files": [
          "api/**.yml",
          "api-vb/**.yml"
        ],
        "exclude": [
          "**/toc.yml",
          "**/toc.md"
        ]
      },
      {
        "files": [
          "articles/**.md",
          "articles/**/toc.yml",
          "toc.yml",
          "*.md",
          "pdf/*"
        ],
        "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"
  }

好了, 讓我們運行 docfx,你會在 _site_pdf 目錄發(fā)現(xiàn)生成了 walkthrough3_pdf.pdf pdf文件:

PDF Preview

總結(jié)

在本演練中默终,我們根據(jù) pdf 文件夾下的TOC文件構(gòu)建一個PDF文件椅棺。 請注意,TOC在PDF生成中起著重要作用齐蔽,它不僅可以指定PDF中包含的文件两疚,還可以指定此PDF文件的封面。 一個TOC文件生成一個PDF文件含滴,所以不要忘記從docfx.json中排除不需要的TOC文件鬼雀。

更多相關(guān)文件

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市蛙吏,隨后出現(xiàn)的幾起案子源哩,更是在濱河造成了極大的恐慌鞋吉,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,657評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件励烦,死亡現(xiàn)場離奇詭異谓着,居然都是意外死亡,警方通過查閱死者的電腦和手機坛掠,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,889評論 3 394
  • 文/潘曉璐 我一進店門赊锚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人屉栓,你說我怎么就攤上這事舷蒲。” “怎么了友多?”我有些...
    開封第一講書人閱讀 164,057評論 0 354
  • 文/不壞的土叔 我叫張陵牲平,是天一觀的道長。 經(jīng)常有香客問我域滥,道長纵柿,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,509評論 1 293
  • 正文 為了忘掉前任启绰,我火速辦了婚禮昂儒,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘委可。我一直安慰自己渊跋,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,562評論 6 392
  • 文/花漫 我一把揭開白布着倾。 她就那樣靜靜地躺著刹枉,像睡著了一般。 火紅的嫁衣襯著肌膚如雪屈呕。 梳的紋絲不亂的頭發(fā)上微宝,一...
    開封第一講書人閱讀 51,443評論 1 302
  • 那天,我揣著相機與錄音虎眨,去河邊找鬼蟋软。 笑死,一個胖子當(dāng)著我的面吹牛嗽桩,可吹牛的內(nèi)容都是我干的岳守。 我是一名探鬼主播,決...
    沈念sama閱讀 40,251評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼碌冶,長吁一口氣:“原來是場噩夢啊……” “哼湿痢!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,129評論 0 276
  • 序言:老撾萬榮一對情侶失蹤譬重,失蹤者是張志新(化名)和其女友劉穎拒逮,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體臀规,經(jīng)...
    沈念sama閱讀 45,561評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡滩援,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,779評論 3 335
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了塔嬉。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片玩徊。...
    茶點故事閱讀 39,902評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖谨究,靈堂內(nèi)的尸體忽然破棺而出恩袱,到底是詐尸還是另有隱情,我是刑警寧澤胶哲,帶...
    沈念sama閱讀 35,621評論 5 345
  • 正文 年R本政府宣布畔塔,位于F島的核電站,受9級特大地震影響纪吮,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜萎胰,卻給世界環(huán)境...
    茶點故事閱讀 41,220評論 3 328
  • 文/蒙蒙 一碾盟、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧技竟,春花似錦冰肴、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,838評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至搓扯,卻和暖如春检痰,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背锨推。 一陣腳步聲響...
    開封第一講書人閱讀 32,971評論 1 269
  • 我被黑心中介騙來泰國打工铅歼, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人换可。 一個月前我還...
    沈念sama閱讀 48,025評論 2 370
  • 正文 我出身青樓椎椰,卻偏偏與公主長得像,于是被迫代替她去往敵國和親沾鳄。 傳聞我的和親對象是個殘疾皇子慨飘,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,843評論 2 354

推薦閱讀更多精彩內(nèi)容