1.gitbook


  1. 安装gitbook
    1. 安装gitbook

       $ npm install gitbook-cli -g
    2. 验证安装版本

       $ gitbook -V
       CLI version: 2.3.2
       GitBook version: 3.2.3
  2. 使用('markdown语法')
    1. 创建文件夹工作区并初始化

        $ mkdir 文件夹名 & cd 文件夹名   #默认文件夹名作为书名
        $ gitbook init                  #在文件夹目录下执行初始化命令
    2. 完成后自动生成的目录结构
      SUMMARY.md 书目录结构,默认的介绍连接为 README.md,网站侧栏的目录。
      README.md 介绍文章

    3. 编写文章,并在SUMMARY.md添加连接

    4. 构建

       $gitbook build # 可选参数: 书路径 输出路径,
    5. 生成, 生成电子书需要安装 转换软件,并添加环境变量。

      1. 网页本地预览,启动成功后使用浏览器访问 ``

             $ gitbook serve # 可选参数: --port 本机电脑端口
      2. 生成pdf电子书

             $ gitbook pdf  # 可选参数 书路径 输出文件路径
      3. 生成epub电子书

             $ gitbook epub   # 可选参数 书路径 输出文件路径
      4. 生成mobi电子书

             $ gitbook mobi   # 可选参数 书路径 输出文件路径
  3. 插件安装方法
    1. 方法一 (速度慢)
      1. 在书目录新建 book.json, 添加需要安装的插件 { "plugins":[ "-lunr", "-search", "search-pro", "expandable-chapters", "chapter-fold", "splitter", "anchor-navigation-ex", "back-to-top-button", "prism","-highlight", "tbfed-pagefooter" ], "pluginsConfig": { "prism": { } } }
      2. 执行 gitbook install
    2. 方法二 $ npm install gitbook-plugin-插件名
    3. 方法三
      1. npm init 初始化一个package.json
      2. 在package.json中dependencies添加插件
      3. 使用npm install安装插件
  4. 常用插件
    1. 搜索search-pro
      1. 兼容性,需要gitbook >= 3.0.0 support,
      2. 插件安装排除冲突"-lunr", "-search", "search-pro"
    2. 左侧可折叠菜单栏chapter-fold
      1. 插件安装 "chapter-fold"
      2. 插件配置 "chapter-fold":{}
    3. 左侧可折叠菜单栏2expandable-chapters
      1. 插件安装 "expandable-chapters"
      2. 插件配置 "expandable-chapters":{}
    4. 可调节侧栏宽度splitter
      1. 插件安装 "splitter"
    5. 页面内目录page-treeview
      1. 插件安装 "page-treeview"
      2. 插件配置 "page-treeview": { "copyright": "Copyright © aleen42", "minHeaderCount": "2", "minHeaderDeep": "2" }
    6. 悬浮按钮目录anchor-navigation-ex
      1. 插件安装 "anchor-navigation-ex"
    7. 回到顶部back-to-top-button
      1. 插件安装 "back-to-top-button"
    8. 数学公式支持mathjax-pro
      1. 插件安装 "mathjax-pro"
      2. 插件配置 "mathjax-pro":{ "version": "2.7.5" }
    9. 流程图flowchart
      1. 插件安装 "flowchart"
      2. 插件配置 "flowchart": { "line-color": "red" }
  5. 其他内容

文章作者: lyg
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 lyg !
  目录