gitbook，markdown 转 web 页面神器

gitbook，markdown 转 web 页面神器

gitbook 的默认语法就是 markdown，能够很好的展现你的内容，排版都不需要你担心，在此基础上，会自动生成目录、父子级、划分列表，让你把所有的精力都放在内容，还可以直接部署在互联网上，以电子书的方式展示，真的是太方便了

gitbook 官方链接

安装 cli

npm install gitbook -g

//查看版本

gitbook -V

初始化项目

mkdir book

cd book

gitbook init

会出现如下报错 ↓

导致原因是：本地 node 版本高，可以尝试把本地 node 版本降低到 12+。成功如下：

1. 添加 book.json 文件,里面都是关于生成项目的配置信息，内容如下：

{
  "gitbook": ">=3.2.3",
  "language": "zh-hans",
  "title": "小学都没毕业的前端攻城狮",
  "description": "文档描述",
  "structure": {
    "readme": "README.md",
    "summary": "SUMMARY.md"
  },
  "plugins": [
    "highlight",
    "search-plus",
    "splitter",
    "back-to-top-button",
    "tbfed-pagefooter",
    "expandable-chapters",
    "chapter-fold",
    "code",
    "hide-element",
    "theme-comscore",
    "theme-fexa"
  ],
  "pluginsConfig": {
    "hide-element": {
      "elements": [".gitbook-link"]
    },
    "theme-fexa": {
      "logo": "logo.png"
    }
  }
}

2. 安装项目依赖

gitbook install

3. 编写项目

• init 生成的 SUMMARY.md 中列出的所有 Markdown 将会被转为 HTML 文件，也是生成目录列表的格式文件
• 把自己需要生成 HTML 文档的.md 文件放到项目目录中，并在 SUMMARY.md 引用
• 自己.md 文件中的静态资源可以创建 image 文件夹用来统一存放，不用 cdn 链接，提生浏览流畅度。

构建项目

使用下面的命令，会在项目的目录下生成一个 _book 目录，里面的内容为静态站点的资源文件：

gitbook build

整体目录如下：

项目启动

gitbook serve

//本地服务启动成功，可以构建的web页面了。
Starting server ...
Serving book on http://localhost:4000

Gitbook 启动项目在一些环境下会报如下错误：

/usr/local/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:299
      if (cb) cb.apply(this, arguments)
                 ^
TypeError: cb.apply is not a function
    at /usr/local/lib/node_modules/gitbook-cli/node_modules/npm/node_modules/graceful-fs/polyfills.js:299:18

解决办法：按错误提示的路径找到 polyfills.js，将 65 行起的三行都大胆注释掉,如下：

// fs.stat = statFix(fs.stat)
// fs.fstat = statFix(fs.fstat)
// fs.lstat = statFix(fs.lstat)

启动成功，开心

总结：

gitbook 常用命令

• gitbook help //列出 gitbook 所有的命令
• gitbook --help //输出 gitbook-cli 的帮助信息
• gitbook build //生成静态网页
• gitbook serve //生成静态网页并运行服务器
• gitbook update //更新到 gitbook 的最新版本

有疑问的同学可以私信我、对帮助到同学欢迎大家收藏评论。