使用GitBook編寫專案文件

2022-08-01 03:03:17 字數 4542 閱讀 8208

gitbook簡介

gitbook 是使用 github / git 和 markdown（或asciidoc）構建漂亮書籍的命令列工具（和node.js庫）；

gitbook 可以將您的內容作為**（可定製和可擴充套件）或電子書（pdf，epub或mobi）輸出；

gitbook環境安裝（需要安裝nodejs環境）

nodejs安裝：

windows下：

linux下：

解壓$ cd node-v10.9.0-linux-x64/ //

進入解壓目錄

$ ./bin/node -v //

執行node命令 檢視版本

v10.9.0

解壓檔案的 bin 目錄底下包含了 node、npm 等命令，我們可以使用 ln 命令來設定軟連線：

$ ln -s /usr/software/nodejs/bin/npm   /usr/local/bin/ 


$ ln -s /usr/software/nodejs/bin/node /usr/local/bin/
gitbook安裝：

gitbook是使用npm來進行安裝的，可以在命令列中輸入下面的命令進行安裝：

$ npm install gitbook-cli -g
gitbook-cli是 gitbook 的乙個命令列工具。它將自動安裝所需版本的 gitbook 來構建一本書，

安裝完成之後，你可以使用下面的命令來檢驗是否安裝成功。

$ gitbook -v


cli version: 


2.3.2


gitbook version: 


3.2.3
gitbook命令列使用

初始化一本書：

gitbook init
在使用gitbook init之後本地會生成兩個檔案readme.md和summary.md，這兩個檔案都是必須的，乙個為介紹，乙個為目錄結構。

首先，gitbook使用summary.md檔案組織整個內容的目錄，比如可以新建faq.md檔案，來記錄常見問題，並在 summary.md 檔案中新增目錄。

# summary


*[簡介](readme.md)


* [常見問題](faq.md)
安裝外掛程式:

在book.json檔案下配置外掛程式後，執行命令統一安裝。

gitbook install
本地預覽：

當內容書寫完畢後，可以在終端中輸入如下命令，實現實時預覽。

gitbook serve


gitbook serve ./
gitbook serve命令實際會先呼叫gitbook build編譯書籍，完成後開啟 web 伺服器，預設監聽本地 4000 埠，在瀏覽器開啟 http://localhost:4000 即可瀏覽電子書。

發布電子書：

gitbook build


gitbook build ./ --output=./


gitbook build ./ --log=debug --debug
當電子書內容製作好之後，可以使用如下命令來生成 html 靜態網頁版電子書。該命令會在當前資料夾中生成_book資料夾，這個資料夾中的內容就是靜態網頁版電子書。

使用--log=debug --debug可以用來除錯，會列印出 stack trace。

檢視幫助：

gitbook -h
gitbook專案結構

乙個基本的 gitbook 電子書結構通常如下：

.


├── book.json


├── readme.md


├── summary.md


├── chapter-1/


|├── readme.md


|└── something.md


└── chapter-2/├── readme.md


└── something.md
簡單的介紹下每個檔案的作用：

book.json：    記錄電子書的配置 (可選)

readme.md：    前言 或者 電子書的介紹 (必須)

summary.md：    電子書的目錄 (可選)

glossary.md：    術語表 (可選)

使用語法

在gitbook中所有文字的編寫都使用markdown語法。

readme.md:

這個檔案相對於是一本gitbook的簡介，比如 :

# gitbook 使用入門


> gitbook 是乙個基於 node.js 的命令列工具，可使用 github/git 和 markdown 來製作精美的電子書。
summary.md:

這個檔案相對於是一本書的目錄結構，比如 :

*[介紹](readme.md)


* [基本安裝](installation/readme.md)


* [node.js安裝](installation/nodejs-install


.md)


* [gitbook安裝](installation/gitbook-install


.md)


* [gitbook命令行速覽](installation/gitbook-cli.md)


* [圖書專案結構](book/readme.md)


* [readme.md 與 summary編寫](book/file


.md)


* [目錄初始化](book/prjinit.md)


* [圖書輸出](output/readme.md)


* [輸出為靜態**](output/static.md)


* [輸出pdf](output/pdfandebook.md)


* [發布](publish/readme.md)


* [發布到github pages](publish/gitpages.md)


* [發布到公司文件伺服器](publish/companyserver.md)


* [結束](end/readme.md)
book.json:

這個檔案儲存對gitbook的配置。

變數描述

root

包含所有圖書檔案的根資料夾的路徑，除了book.json

structure

指定自述檔案，摘要，詞彙表等的路徑

title

您的書名，預設值是從 readme 中提取出來的。在 gitbook.com 上，這個欄位是預填的

description

您的書籍的描述，預設值是從 readme 中提取出來的。在 gitbook.com 上，這個欄位是預填的

author

作者名。在gitbook.com上，這個欄位是預填的

isbn

國際標準書號 isbn

language

本書的語言型別 —— iso code 。預設值是en

direction

文字閱讀順序。可以是rtl（從右向左）或ltr（從左向右），預設值依賴於language的值

gitbook

應該使用的gitbook版本。使用 semver 規範，並接受類似於「> = 3.0.0」的條件

外掛程式與主題:

外掛程式及其配置也在book.json中指定。有關詳細資訊。

自 3.0.0 版本開始，gitbook 可以使用主題。有關詳細資訊，請參閱  the theming section 。

使用GitBook編寫文件書籍

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

專案文件編寫總結

最近幾周都在根據新的功能需求編寫相對應的文件，先編寫專案立項報告，編寫結束後開始編寫需求規格說明書，之後便是詳細設計說明書，下個階段便是編寫階段了。以前也編寫過需求規格說明書和詳細設計說明書，因為以前經驗少，寫的東西不夠深度沒有特點，有一種為了完成文件而寫。這次完全把自己當做設計，想要讓自己設計的功...

編寫專案需求文件

color darkred b 需求分析文件要點 b color color darkred 以下需求文件要點適合瀑布式開發過程。color 一般在最前面有編寫者及文件版本和變更記錄等。color darkred b 引言 b b 編寫目的 b color 術語及縮寫解釋 預期的讀者和閱讀建議 co...