GitBook 使用笔记

1. 安装

• 1.1 安装NodeJs
• 1.2 Gitbook 命令行工具安装 ,详情参考 >gitbook 安装配置官方文档
  npm install gitbook-cli -g

2. 使用

了解下面几点，基本就可以愉快的在本地写书了

2.1 命令行基本命令使用

• 新建书籍，在目录中执行：
  gitbook init
• 构建预览html文件
  gitbook build
• 开启服务在浏览其中预览
  gitbook serve

传送门:
安装使用：Setup and Installation of GitBook

• 编辑后提交到Git库：

git add .    
git commit -m "提交备注"

2.2 了解目录结构

不累述，直接传送官方说明:

传送门：
目录结构
页面和内容目录

2.3 了解book.json 配置方法

传送门：
book.json 配置

3. 插件安装与配置

插件搜索浏览: GitBook Plugins

3.1 代码高亮

1) prism插件

点击上方链接查看如何配置(下同)

3.2 TOC(Table of Content)

1) 页面内 - navigator

在标题下方显示目录

2) 侧边 - simple-page-toc

• 在右上方显示一个TOC 按钮，点击后显示目录
• 在右上方显示一个Top 按钮，点击后回到文章顶部

3.4 目前的配置大集合

{
    "title": "项目文档记录",
    "description": "项目文档记录",
    "language": "zh",
    "plugins": [
        "prism",
        "-highlight",
         "simple-page-toc",
         "navigator"
    ],
    "pluginsConfig": {
        "simple-page-toc": {
            "maxDepth": 3,
            "skipFirstH1": true
       }
    }
}

4. 使用文档编辑器

GitbookEditor

GitBook 官方出品 ,下载链接 GitbookEditor,如果不熟悉基本的git命令，那么最好使用这个

Sublime Text

参考：Windows上使用Sublime编辑markdown并预览
另外提下Sublime 有个Open Folder 功能，可以在左侧显示目录树，更方便的是可以在增加文件目录，重命名文件目录

工作流程：
Sublime中修改　-- gitbook serve 预览 -- git add . 及git commit -m "msg" 提交 -- git push 推送

5. 编辑(Markdown语法)

传送:
Markdown

• 代码高亮
  指定代码语言-添加ruby 指定语言为ruby

    ```ruby
      require 'redcarpet'
      markdown = Redcarpet.new("Hello World!")
      puts markdown.to_html 

参考

gitbook 安装配置官方文档