Gitbook的使用教程

Gitbook的使用教程

GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书

安装

由于gitbook是基于node.js的,所以在安装gitbook之前需要先安装node。

npm install -g gitbook-cli

检验是否安装成功

gitbook -V

使用

新建一个文件夹,如myBooks,并在该文件夹目录下执行以下操作。

初始化

gitbook init

此时在myBooks目录下会发现多出了README.md 和 SUMMARY.md 这两个文件,其中README.md用来对此项目进行介绍说明,SUMMARY.md 用来编写gitbook的章节目录。

启动

gitbook serve

执行完上述命令后根据提示在浏览器地址栏中输入http://localhost:4000访问即可看见基本的效果,如下图所示。
Gitbook的使用教程_第1张图片

生成 _book 文件夹

gitbook build

运行该命令后会在myBooks文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件,同时也可以使用如下命令来生成网页而不开启服务器。

目录编写

gitbook的目录结构主要由SUMMARY.md文件决定,它通过 Markdown 中的列表语法来表示文件的父子关系,简单的示例如下所示。

# 目录

* [前言](README.md)
* [vue](vue/README.md)
  * [第1节:vue指令总结与介绍](vue/指令.md)
  * [第2节:vue动画总结与介绍](vue/动画.md)
* [vue-router](vue-router/README.md)
  * [第1节:vue-router的模式简介](vue-router/模式.md)
  * [第2节:命名路由](vue-router/命名路由.md)
* [vuex](vuex/README.md)
* [移动端插件](mobile/README.md)
* [PC端插件](PC/README.md)
* [问题整理](Questions/README.md)

目录生成

目录编写完成之后,在命令行中输入如下命令,执行完成后再次启动项目即可预览最终效果。

gitbook init

GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建。

Gitbook的使用教程_第2张图片

其他命令整理

  1. build 命令指定路径
gitbook build [书籍路径] [输出路径]
  1. serve 命令指定端口
gitbook serve --port 2333
  1. 生成 PDF 格式的电子书
gitbook pdf ./ ./mybooks.pdf
  1. 生成 epub 格式的电子书
gitbook epub ./ ./mybooks.epub
  1. 生成 epub 格式的电子书
gitbook mobi ./ ./mybooks.mobi

参考地址
链接1
链接2

你可能感兴趣的:(工具分享)