用GitBook搭建文檔系統

通過MarkDown寫文檔,自動生成html在線文檔,還可以實時預覽,這一切可以通過gitbook來進行。

1.安裝node.js  windows版本

2.打開cmd輸入下面的命令以安裝gitbook 

 npm install -g gitbook-cli

 3.隨便新建一個文件夾打開cmd,輸入

 gitbook init

生成如下圖

 

4.輸入以下命令,gitbook以供瀏覽器查看

 gitbook serve

5.打開瀏覽器 127.0.0.1:4000

至此gitbook環境搭建完畢。

 

在gitbook的目錄新建 book.json 輸入以下內容

{
	"title": "用戶手冊",
	"plugins": ["hide-element","chapter-fold"],
	"pluginsConfig": {
		"chapter-fold": {},
		"hide-element": {
			"elements": [".gitbook-link"]
		}
	}
}

上面的設置包含了2個插件,一個是去掉logo,一個是摺疊菜單。

 

打開命令行輸入以下命令

 gitbook install

 

輸入以下命令 生成html頁面,生成的html文件位於當前的額_book目錄zhong

 gitbook build

 

至此,可以通過MD編寫文檔了。

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章