gitbook 安装和使用【写给自已】
之前在使用本地 gitbook 的时候一直没有纠结于插件的安装,然后当左侧目录列表特别多的时候就觉得需要一个折叠收起的功能,于是就安装折腾了一下gitbook的插件安装,害怕后面忘记过程。so 在这里写点什么把它记录下来。
一、gitbook 下载和安装
1. 安装nodejs 环境: 这里略过,可以去官网下载稳定版本的node 然后一路next ,推荐版本号大于 v4.0
2. 使用 node -v 来验证安装是否成功
3. 如果可以,建议安装 淘宝镜像,方便后续使用 cnpm 来代替我们的 npm 【 默认情况下会在当前电脑管理员目录下生成 cnpm 和 cnpm-cache 二个子目录,后续也可以直接删除nmp安装的包 】
4. 使用 npm install gitbook-cli -g 来安装 gitbook ,然后通过 gitbook -V 来验证是否安装成功 【 此时会在管理员目录下生成 .gitbooks 目录 】
二、gitbook 本地使用
1. 安装成功之后就可以开始书写自已的 gitbook 了【 当然,gitbook 肯定要用到 markdown 所以需要这部分的语法知识,但是肯定也不会难 】
2. 在自已需要的地方新建目录,以桌面为例 可以新建一个 test 目录。然后在当前目录下黑窗口执行 git init 命令初始化目录
3. 初始化成功之后就可以在当前目录下生成对应的二个 ***.md 文件,一个简单,一个是目录
4. 进入md文件就可以编辑自已的电子书了【 这里可以使用第三方的工具,也可以自已用 markdown 的语法直接写 】
5. 写完之后就可以在之前的黑窗口中执行 gitbook build 命令,然后在默认的目录里就会生成对应的 _book ,它里面就有 html 文件【 默认是新版本gitbook 所以左侧导航可能是无法点击 】
6. 如果出现上述的现象,我们就可以使用 gitbook build --gitbook=2.6.7 来指定对应的版本生成 html
三、gitbook 的插件安装
1. 如果想要通过插件来让我们的 gitbook 更加好用,就需要进行安装和配置。【 有大牛说过这里可以自动安装,但是我感觉我只能本地安装 】
2. 我上述使用的是 gitbook=2.6.7 版本,所以我们需要在对应的目录下安装插件,我的目录是在 管理员目录下的 .gitbook 里,在 version 里找到对应的目录,然后在2.6.7这个目录下执行 cnpm install *****
3. 具体的插件可以去gitbook插件 官网上查找
4. 需要注意的是,如果想要使用插件那么我们就需要在自已 gtibook 目录下新建 book.json 文件,然后去配置。