GitBook 導(dǎo)入文檔

2021-03-02 10:24 更新

將文檔導(dǎo)入 GitBook 很簡單。當(dāng)你創(chuàng)建一本新書的時候,使用 Import 標(biāo)簽頁就可以上傳文檔。

支持的格式

類型 后綴名
Microsoft Word 文檔 .docx
DocBook v5.x .xml
HTML 文件 .html

為了充分使用它的特性,我們推薦你使用:

  • Microsoft Word 2007+ 文檔
  • DocBook v5.x 文檔

如果你有 DocBook v4.x 的文檔,可以考慮將它們 轉(zhuǎn)化 成 DocBook v5.x 來解決兼容性問題。

轉(zhuǎn)化

導(dǎo)入文檔的特性使用了 gitbook-convert 命令行程序。這個組件負(fù)責(zé)將原始文檔轉(zhuǎn)化到 makrdown 文件,以及 SUMMARY.md 的創(chuàng)建。

gitbook-convert 根據(jù)文章的結(jié)構(gòu),將文章劃分成章節(jié)和子章節(jié)。因此,原始文檔的一級標(biāo)題都會被轉(zhuǎn)化成一個章節(jié)。如果一個章節(jié)包含二級標(biāo)題,則會為這個章節(jié)創(chuàng)建一個目錄來包含每個子章節(jié)。

在章節(jié)目錄里,會創(chuàng)建一個包含章節(jié)前言的 README.md 文件。第一個二級標(biāo)題前的所有內(nèi)容會被認(rèn)為是一個章節(jié)的前言。這樣的規(guī)則同樣適用于第一個一級標(biāo)題前的所有內(nèi)容,它們會成為為書的前言。

對于 .docx 文檔,gitbook-convert 會將文檔包含的所有圖片導(dǎo)出到 assets/ 目錄中。

如果你需要更多的靈活性,可以考慮在本地使用 gitbook-convert,然后用 Git 或 GitHub 新建一個倉庫并導(dǎo)入轉(zhuǎn)化后的內(nèi)容。

疑難解答

我們很愿意幫忙解決你在使用 GitBook 時遇到的問題。你可以在 github.com/GitbookIO/gitbook-convert 提問或標(biāo)注一個問題。


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號