博客
关于我
GitBook制作电子书使用教程
阅读量:740 次
发布时间:2019-03-23

本文共 1671 字,大约阅读时间需要 5 分钟。

GitBook 文档优化版

一、概述

GitBook 是一款基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种格式,它可以将文档转换为 HTML、PDF、电子书等多种格式。GitBook 与 Markdown 和 Git 结合使用,是一种高效的文档管理与分享方式。通过 GitBook,您可以轻松创建电子书并托管至云端(如 GitHub、GitLab 等),实现多人协作。

二、安装

  • 安装 Node.js

    下载并安装 Node.js(建议下载地址:https://nodejs.org/en/download/)

  • 安装 GitBook CLI

    全局安装 GitBook 命令行工具:

    npm install -g gitbook-cli

    或者使用 cnpm:

    cnpm i gitbook -g
  • 安装相关工具

    • Markdown 编辑器:Typora(下载地址:https://typora.io/Git)
    • Git:下载 Git 客户端(地址:https://git-scm.com/downloads)
  • 三、使用

  • 创建 mybook 文件夹并执行以下命令:

    gitbook init

    初始化后,会生成 README.mdSUMMARY.md 两个文件:

    • README.md:书籍简介
    • SUMMARY.md:目录结构
  • 编辑 SUMMARY.md

    内容建议如下:

    # 目录* [前言](README.md)* [第一章](Chapter1/README.md)* [第一节:衣](Chapter1/衣.md)* [第二节:食](Chapter1/食.md)* [第三节:住](Chapter1/住.md)* [第四节:行](Chapter1/行.md)* [第二章](Chapter2/README.md)* [第三章](Chapter3/README.md)* [第四章](Chapter4/README.md)
  • 再次初始化

    mybook 文件夹中再次执行:

    gitbook init

    GitBook 会根据 SUMMARY.md 自动生成或更新相关文件

  • 四、命令操作

    • 预览书籍

      gitbook serve

      生成的书籍可以通过 http://localhost:4000预览

    • 构建书籍

      gitbook build

      生成静态网站到 _book 目录

    • 指定输出路径

      gitbook build [输入路径] [输出路径]
    • 自定义端口

      gitbook serve --port 2333
    • 生成电子书

      • PDF:
        gitbook pdf ./ mybook.pdf
      • EPUB:
        gitbook epub ./ mybook.epub
      • MOBI:
        gitbook mobi ./ mybook.mobi
    • 版本管理

      mybook 文件夹中执行:

      git initgit remote add [远程仓库地址]

    五、常见问题

    • 安装延迟问题

      配置 cnpm 镜像仓库:

      npm config set registry=http://registry.npm.taobao.org -g
    • 生成电子书失败

      需要安装 Calibre(下载地址:https://calibre-ebook.com/download_windows64),并配置环境变量后再运行 gitbook pdf 等命令

    • 书籍无法跳转

      • 原因:GitBook 新版本禁用了 JavaScript 导致点击跳转失效
      • 解决方法
      • 卸载最新版本并切换到旧版本:
        gitbook uninstall 3.2.3gitbook build --gitbook=2.6.7
      • 或者手动指定旧版本:
        gitbook build --gitbook=2.6.7
    • 下载旧版本 GitBook CLI

      gitbook fetch 2.6.7gitbook build --gitbook=2.6.7

    通过以上命令,您可以轻松创建和管理电子书,完善文档内容,并解决常见问题。

    转载地址:http://azkzk.baihongyu.com/

    你可能感兴趣的文章
    6天掌握mysql基础视频教程
    查看>>
    7 Tips For Better JDeveloper Experience
    查看>>
    70. 爬楼梯
    查看>>
    7B2 PRO主题5.4.2免授权直接安装
    查看>>
    7大常用JCL 模板
    查看>>
    111
    查看>>
    80个Python经典资料(教程+源码+工具)汇总——下载目录
    查看>>
    80个Python经典资料(教程+源码+工具)汇总——下载目录
    查看>>
    8个微信实用技巧,你知道多少?
    查看>>
    8点FFT的C语言实现
    查看>>
    950个织梦网dede模板源码
    查看>>
    : bad interpreter: 没有那个文件或目录
    查看>>
    @Cacheable@CacheEvict@CachePut
    查看>>
    2018信息平台专场招聘
    查看>>
    @ControllerAdvice+@ExceptionHandler全局处理Controller层异常 及其 原理
    查看>>
    @ControllerAdvice、@ExceptionHandler控制全局Controller异常
    查看>>
    @ControllerAdvice用法
    查看>>
    #VERDI# 关于Verdi使用的几个常用技巧整理
    查看>>
    @Resource注解的使用
    查看>>
    @ResponseBody 和 @RequestBody
    查看>>