1.gitbook

gitbook

[TOC]

一 概述

4 网址文档等

官方网址

  1. legacy.gitbook.com和gitbook.com:前者是旧版的网址,后者是新版。简单试了下,好像只有新版可以把github的内容复制过去,而且自动同步目前没有生效。

二 安装配置

  1. 安装gitbook脚手架

    1. 执行npm install gitbook-cli -g,该命令不会安装gitbook

    2. 运行gitbook -V,运行时会自动安装gitbook

      gitbook -V
      CLI version: 2.3.2
      Installing GitBook 3.2.3 # 耗时较久,可能几分钟到半小时
    3. 安装了gitbook-cli之后执行gitbook(如果是win系统,用gitbook.cmd替换gitbook)的命令

      1. 如果没有安装node,此时会显示node的提示

      2. 然后会显示installing gitbook 3.2.3,等它装完了之后命令才执行(大概安装1至5分钟)(安装的这个算不算npm模块呢?待补充)

  2. README.md 和 SUMMARY.md 是两个必须文件,README.md 是对书籍的简单介绍,SUMMARY.md 是书籍的目录结构

三 基础

1 未整理

  1. 网上大神说的:

    “好像从 3.0.0 版起, gitbook build 生成的 website 就不支持 local 打开了, 必需要 webserver 开启; 实在要完全静态的, 就安装 2.6.7 版吧( 在有些浏览器下估计不太完美 )”

2 目录

目录中不能使用/(\?),否则会被拆分成文件夹和文件

四 高级

五 经验

基本上暂时只需要掌握两个命令就行了:gitbook init 和gitbook build,前者根据summary.md生成目录和文件,后者是生成静态网页文件

六 问题

  1. 当前gitbook的版本是2.3.2,在win10执行gitbook initorgitbook -V的时候出现

    Installing GitBook 3.2.3
    ...
      if (cb) cb.apply(this, arguments)
                 ^
    
    TypeError: cb.apply is not a function
    ...

    方法一(推荐):切换到v10.24.1的nodejs版本 方法二:根据错误提示可知Polyfills.js文件第287行有问题,看注释是为了解决老版本bug,然后找到调用这个函数的地方(62、63、64行)并注释掉,然后再运行就ok了

  2. 当前gitbook的版本是3.2.3,在win10执行gitbook init的时候出现

    info: create SUMMARY.md 
    
    TypeError [ERR_INVALID_ARG_TYPE]: The "data" argument must be of type string or an instance of Buffer, TypedArray, or DataView. Received an instance of Promise

    当前node版本是v16.13.0,借助搜索引擎可知node版本太高了,降到12才行,

Last updated

Was this helpful?