欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

GitBook使用

程序员文章站 2022-06-01 16:31:47
...

GitBook使用

GitBook是一个使用 Git 和 Markdown 来构建书籍的工具,实际上,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出 HTML、PDF、eBook 等格式的电子书。网上有人把 GitBook 定义为文档格式转换工具。
  
所以,GitBook 不是 Markdown 编辑工具,也不是 Git 版本管理工具。市面上我们可以找到很多 Markdown 编辑器,比如 Typora、MacDown、Bear、MarkdownPad、MarkdownX、JetBrains’s IDE(需要安装插件)、Atom、简书、CSDN 以及 GitBook 自家的 GitBook Editor 等等。

准备工作

  1. GitBook官网
  2. GitBook文档
  3. Node环境安装

安装Node.js(Node.js都会默认安装npm(node包管理工具),所以不需要单独安装npm)

$ node -v
v10.23.2

$ npm -v
6.14.10

安装 GitBook

输入下面的命令来安装 GitBook。

$ npm install gitbook-cli -g

安装成功

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

编辑器Typora

可以用 gitbook editor、Typora 等自己喜欢的来编辑,我使用的是typora官网

Gitbook的使用

$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished

执行之后默认当前目录下会生成两个文件:README.md 和 SUMMARY.md ,README.md 就是说明文档,而 SUMMARY.md就是书的章节目录

$ ls
README.md  SUMMARY.md

SUMMARY内容

$ cat SUMMARY.md
# Summary

* [Introduction](README.md)

运行gitbook server

$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 1 pages
info: found 0 asset files
info: >> generation finished with success in 1.4s !

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

输入:gitbook serve 命令,然后在浏览器地址栏中输入 http://localhost:4000 便可预览书籍。运行该命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html 文件,我们可以使用下面命令来生成网页而不开启服务器。

$ gitbook build

上面是最简单的GitBook结构,你可以自己编辑SUMMARY.md目录,然后使用typora写md文档了。

相关标签: markdown