gitbook簡單教程

簡介

GitBook 是一個基於 Node.js 的命令行工具，可以使用 Github/Git 和 Markdown 來製做精美的電子書。GitBook支持輸出如下幾種文檔格式

靜態站點：GitBook默認輸出該種格式

PDF：須要安裝gitbook-pdf依賴

eBook：須要安裝ebook-convert

準備安裝

在使用GitBook 以前, 咱們須要先安裝一些必須的工具:

• Node.js
• GitBook
• GitBookEditor
• Git版本控制器。

Node.js

Node.js是一個基於 Chrome V8 引擎JavaScript 運行環境。

• Node.js 使用了一個事件驅動、非阻塞式 I/O 的模型，使其輕量又高效。
• Node.js 的包管理器 npm, 是全球最大的開源庫生態系統。

Node.js 下載（windows）

Node.js中文網

檢查是否安裝成功

node -v

gitbook

//全局安裝
npm install gitbook -g

gitbook-cli

//全局安裝，你將有權訪問系統上的任何地方的gitbook命令
npm install -g gitbook-cli

Git

Git是一款免費、開源的分佈式版本控制系統，用於敏捷高效地處理任何或小或大的項目。基本安裝請點擊安裝教程。若是不須要從GitHub更新書到本地再編譯，則能夠不安裝Git。

GitBookEditor

GitBook官方客戶端編輯器，支持Win、Linux、Mac系統。請點擊下載GitBookEditor。使用該編輯器能夠快速的建立、編輯GitBook。

基本使用

GitBook 大體分爲兩種使用方式，即離線和在線。最簡單的使用方式是使用GitBook Editor編輯GitBook ，而後使用相關命令編譯成功HTML。固然還有如下幾種方式

• 使用命令建立基本GitBook
• 使用網頁在線編輯器建立、編輯GitBook。
• 使用itBookEditor客戶端建立、編輯GitBook。

高級擴展

掌握了「基本使用」，但有時候想要gitBook更美觀，或者更符合咱們本身的需求，則經過book.json配置進行自定義、以及安裝一些經常使用的插件等。

本地項目構建

新建文件夾gitbook, 在文件夾下建立下面3個文件

• README.md 關於文檔，在 SUMMARY.md 進行配置
• SUMMARY.md 文檔目錄
• book.json 文檔框架，最核心的文件

1.SUMMARY.md

文檔的目錄結構，全部須要展現的文檔都須要在它裏面進行羅列。

詳細 GitBook 官方英文文檔

# Summary
* [前言](README.md)

2.book.json

示例:

{
    "root": "./",
    "title": "示例文檔",
    "head_title": "_示例文檔_字條網",
    "head_description": "示例文檔",
    "head_keywords": "示例文檔",

    "gitbook": ">= 3.0.0",

    "language": "zh-hans",

    "plugins": [
        "-sharing",
        "-fontsettings",
        "-lunr",
        "-search",
        "search-pro",
        "theme-official",
        "sitemap-general"
    ],

    "pluginsConfig": {
        "sitemap-general": {
            "prefix": "http://zitiao.org/simple/"
        }
    }
}

安裝依賴

在文件夾gitbook下運行:

//安裝項目依賴
npm install

//安裝gitbook依賴
gitbook install

//會安裝所需的全部插件，當自動打印以下文字，表明安裝成功：
info: >> plugin "sitemap-general" installed with success

編譯文件

gitbook build

運行

gitbook serve

//當自動打印出以下文字，就代碼運行成功：

Starting server ...
Serving book on http://localhost:4000

在瀏覽器裏訪問 http://localhost:4000 就能看到文檔了!

修改端口號

gitbook serve --port 4002

如今訪問 http://localhost:4002 就能夠看到端口號變成4002了！