您好,登錄后才能下訂單哦!
本文小編為大家詳細介紹“gitbook怎么編寫產品文檔并部署到云服務器中”,內容詳細,步驟清晰,細節處理妥當,希望這篇“gitbook怎么編寫產品文檔并部署到云服務器中”文章能幫助大家解決疑惑,下面跟著小編的思路慢慢深入,一起來學習新知識吧。
GitBook簡介
GitBook 是一個基于 Node.js 的命令行工具,可以用來制作精美的電子書,一些互聯網公司甚至已經使用 GitBook 來編寫自己的產品文檔和操作文檔。功能強大,使用方便,用過都說好。
很多人疑惑 GitBook 是不是 Git 家族的相關產品,其實 GitBook 和 Git 的關系就像雷鋒與雷峰塔的關系一樣,沒有半毛錢關系。
GitBook 可以使用 Markdown 編輯器來編寫書籍,然后也可以使用 Github/Git 來維護和管理書籍版本,多人協同編寫等。
制作出來的電子書可以支持輸出多種文檔格式。
GitBook安裝部署在服務器上
首先根據服務器的操作系統下載 Node.js,下面我主要根據 CentOs 系統進行 Node.js 安裝演示。
準備工作:
云服務器:億速云云服務器;
操作系統:CentOs;
1、以 yum 方式安裝 Node.js。
curl -sL https://rpm.nodesource.com/setup_10.x | bash -yum install -y nodejs
接下來看看是否安裝成功。
[root@localhost /]# node -v v12.16.0 [root@localhost /]# npm -v 6.13.4
2、安裝 GitBook。
全局安裝:npm install gitbook-cli -g 這個執行完畢之后,gitbook -v 可以查看到gitbook版本,就表示安裝成功。
GitBook 有如下命令,常用到的有前面6個:
gitbook init //初始化目錄文件 gitbook help //列出gitbook所有的命令 gitbook –help //輸出gitbook-cli的幫助信息 gitbook build //生成靜態網頁 gitbook serve //生成靜態網頁并運行服務器 gitbook build –gitbook=2.0.1 //生成時指定gitbook的版本, 本地沒有會先下載 gitbook ls //列出本地所有的gitbook版本 gitbook ls-remote //列出遠程可用的gitbook版本 gitbook fetch 標簽/版本號 //安裝對應的gitbook版本 gitbook update //更新到gitbook的最新版本 gitbook uninstall 2.0.1 //卸載對應的gitbook版本 gitbook build –log=debug //指定log的級別 gitbook builid –debug //輸出錯誤信息
創建 GitBook 電子書
進入想要創建電子書的目錄執行 gitbook init 命令。
等待執行完成之后會在目錄下生成 README.md 文件和 SUMMARY.md 文件,這兩個文件可以使用 Markdown 編輯器進行編寫。SUMMARY.md 文件里面主要寫章節目錄信息,README.md 文件里面主要寫書籍內容。
發布電子書
書籍編寫完成之后 使用上面提到的 gitbook serve 命令將書籍生成靜態網頁并運行服務器。
另外,GitBook 在服務器運行需要開放 4000 端口。
通過配置好服務器的網絡之后就能通過遠程訪問我們部署在服務器上的書籍了。
最后通過訪問 http://億速云服務器IP地址:4000 就可以看到自己的書籍了。
讀到這里,這篇“gitbook怎么編寫產品文檔并部署到云服務器中”文章已經介紹完畢,想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會,如果想了解更多相關內容的文章,歡迎關注億速云行業資訊頻道。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。