如何使用gitbook建立文件web頁面

2021-09-19 07:18:03 字數 1006 閱讀 1580

2、進入cmd或powershell裡,進入專案資料夾;然後npm install -g gitbook-cli     安裝完可檢視版本:gitbook -v;

3、執行完後,你會看到多了兩個檔案 —— readme.md 和 summary.md,它們的作用如下:

4、用編輯器開啟newbook資料夾(我用的vscode,隨意選擇,text也可以)

目錄會生成對應檔案內容;

5、然後我們回到命令列,在專案資料夾中再次執行gitbook init命令。gitbook 會查詢 summary.md 檔案中描述的目錄和檔案,如果沒有則會將其建立。

6、接著我們執行gitbook serve來預覽這本書籍,瀏覽器訪問localhost:4000

7、先將每個頁面對應的內容寫到相對應.md檔案中(相關用到markdown語法,自己搜),寫好後,你可以執行 gitbook build 命令構建書籍,預設將生成的靜態**輸出到 _book 目錄。實際上,這一步也包含在 gitbook serve 裡面,因為它們是 html,所以 gitbook 通過 node.js 給你提供服務了。 

當然,build 命令可以指定路徑:

8、serve 命令也可以指定埠:gitbook serve --port 2333

final:

_book中生成的html網頁可以直接作為**專案中的幫助中心或api文件,但裡面的檔案路徑需要改動,以及左側目錄的最高層(最上級)路徑也需要改動,還有部分樣式問題也可以自己直接在生成的html中修改;

若覺得有用,請點贊!!!

SharePoint Online 建立文件庫

前言 本文介紹如何在office 365中建立文件庫,以及文件庫的一些基本設定。正文 通過登入位址登入到office 365的sharepoint online站點中,我們可以在右上角的設定選單中,選擇新增應用程式 或者,進入 內容,選擇新增應用程式,二者的效果是一樣的 新增應用程式的時候,我們選擇...

使用GitBook編寫文件書籍

gitbook 是乙個基於 node.js 的命令列工具,可使用 github git 和 markdown 來製作精美的電子書。gitbook支援輸出以下幾種文件格式 gitbook可以用來寫書 api文件 公共文件,企業手冊,研究報告等。npm config set registry taoba...

使用GitBook編寫專案文件

gitbook簡介 gitbook 是使用 github git 和 markdown 或asciidoc 構建漂亮書籍的命令列工具 和node.js庫 gitbook 可以將您的內容作為 可定製和可擴充套件 或電子書 pdf,epub或mobi 輸出 gitbook環境安裝 需要安裝nodejs環...