|
1 | | -## 前言 |
2 | | -主要记录GitBook的安装配置以及一些插件信息, 下面是GitBook的一些资源 |
| 1 | +# 前言 |
| 2 | +主要记录 GitBook 的安装配置以及一些插件信息，当前使用的 GitBook 版本为 `3.2.2`。 |
| 3 | + |
| 4 | +## 运行 |
| 5 | +* 安装 GitBook |
| 6 | +```bash |
| 7 | +npm install gitbook-cli -g |
| 8 | +``` |
| 9 | +* Clone 代码到本地并运行 |
| 10 | +```bash |
| 11 | +git clone [email protected]:zhangjikai/gitbook-use.git |
| 12 | +cd gitbook-use |
| 13 | +gitbook install |
| 14 | +gitbook serve |
| 15 | +``` |
| 16 | +* 在浏览器中打开 `http://localhost:4000/` 进行访问 |
| 17 | + |
| 18 | +## GitBook 资源 |
3 | 19 |
|
4 | 20 | * [GitBook主页](https://www.gitbook.com/) |
5 | 21 | * [Github地址](https://github.com/GitbookIO/) |
6 | 22 | * [GitBook编辑器](https://www.gitbook.com/editor/osx) |
7 | 23 | * [GitBook Toolchain Documentation](http://toolchain.gitbook.com/) |
8 | 24 | * [GitBook Documentation](http://help.gitbook.com/) |
9 | 25 |
|
10 | | ---- |
11 | | - |
12 | | -1. [安装](installation.md) |
13 | | -2. [命令](commands.md) |
14 | | -3. [配置](#配置) |
15 | | -4. [插件](#插件) |
16 | | - |
17 | | -### [配置](settings.md) |
18 | | -* [title - 标题](settings.md#title) |
19 | | -* [author - 作者信息](settings.md#author) |
20 | | -* [description - 书本描述](settings.md#description) |
21 | | -* [language - 使用的语言](settings.md#language) |
22 | | -* [links - 在侧边栏添加链接](settings.md#links) |
23 | | -* [styles - 自定义样式](settings.md#styles) |
24 | | -* [plugins - 插件](settings.md#plugins) |
25 | | -* [pluginsConfig - 插件配置](settings.md#pluginsconfig) |
26 | | -* [gitbook - 指定gitbook版本](settings.md#gitbook) |
27 | | - |
28 | | -### [插件](plugins.md) |
29 | | -* [Disqus - Disqus评论](plugins.md#disqus) |
30 | | -* [duoshuo - 多说](plugins.md#duoshuo) |
31 | | -* [Search Pro - 支持中文搜索](plugins.md#search-pro) |
32 | | -* [Advanced Emoji - 支持emoji表情](plugins.md#advanced-emoji) |
33 | | -* [Github - 添加github图标](plugins.md#github) |
34 | | -* [Ace Plugin - 支持ace](plugins.md#ace-plugin) |
35 | | -* [Emphasize - 强调文字(为文字加上底色)](plugins.md#ace-plugin) |
36 | | -* [KaTex - 支持数学公式](plugins.md#katex) |
37 | | -* [Include Codeblock - 使用代码块显示指定文件的内容](plugins.md#include-codeblock) |
38 | | -* [Splitter - 自由调节侧边栏宽度](plugins.md#splitter) |
39 | | -* [Mermaid -支持渲染Mermaid图表](plugins.md#mermaid) |
40 | | -* [sharing - 分享](plugins.md#sharing) |
41 | | -* [Tbfed-pagefooter - 为页面添加页脚](plugins.md#tbfedpagefooter) |
42 | | -* [Toggle Chapters - 折叠章节](plugins.md#toggle-chapters) |
43 | | -* [Sectionx - 将页面分块显示](plugins.md#sectionx) |
44 | | -* [Codeblock-filename - 为代码块添加文件名称](plugins.md#codeblockfilename) |
45 | | -* [ga - google 统计](plugins.md#ga) |
46 | | -* [baidu - 百度统计](plugins.md#baidu) |
47 | | -* [donate - 打赏](plugins.md#donate) |
48 | | -* [Local Video - 使用Video.js播放视频](plugins.md#local-video) |
49 | | -* [toc - 自动生成目录](plugins.md#toc) |
50 | | -* [Edit Link - 链接到当前页源文件上](plugins.md#edit-link) |
51 | | -* [sitemap - 生成sitemap](plugins.md#sitemap) |
52 | | - |
| 26 | +## 目录 |
| 27 | +* [安装](installation.md) |
| 28 | +* [命令](commands.md) |
| 29 | +* [目录结构](structure.md) |
| 30 | +* [配置](settings.md) |
| 31 | +* [插件](plugins.md) |
| 32 | +* [主题](themes.md) |
| 33 | +* [bookjson](bookjson.md) |
0 commit comments