GITBOOK 使用手册

332 阅读1分钟

前言

在日常开发中,我们会遇到很多问题,也会解决很多问题,会总结,会分享,这里就介绍一个写文档利器gitbook, gitbook是由markdown书写文档,最终可以生成pdf、epub、mobi等文件。 初始化时,init可以生成文档目录,方便定位到对应文档。在线运行,实时更新文档内容。

安装工具: Node.js + gitbook-cli + Git

  1. 安装node.js
  2. MacOS 全局安装gitbook-cli : sudo npm install -g gitbook-cli
  3. 安装Git

如何使用

  1. mkdir mybook

  2. cd mybook

  3. gitbook init, 你会发现两个文件 (README.md,SUMMARY.md)

    1. README.md — 介绍你的书籍
    2. SUMMARY.md — 书籍目录
  4. gitbook serve 预览该书籍,执行命令后会对 Markdown 格式的文档进行转换,默认转换为html格式,控制台输出Serving book on http://localhost:4000 ,你也可以自定义启动端口:gitbook serve --port 1230

  5. 执行gitbook build 命令打包书籍,默认将生成的静态网站输出到_book目录,你也可以指定路径:gitbook build [书籍路径] [输出路径]

  6. 还可生成各种格式的文件

    1. pdf格式:gitbook pdf ./ ./mybook.pdf

    2. epub 格式:gitbook epub ./ ./mybook.epub

    3. mobi 格式: gitbook mobi ./ ./mybook.mobi

      如果生成不了,你可能还需要安装一些工具,比如:ebook-convert

  7. gitbook插件官网地址:plugins.gitbook.com/