Gitbook

GitBook 是一个基于 Node.js 的命令行工具，可应用它来制作精美的电子书，同时GitBook提供了大量的插件，以应答各种需要。本文笔者就来具体记录一下GitBook装置过程，并记录在学弟学妹机器中呈现的各种“幺蛾子”。因为GitBook依赖于node.js，因而在装置GitBook前确保曾经装置好了node.js环境。Node版本肯定不要太高，网上倡议v12.16.2否则会产生如下状况： 1. 装置GitBook命令行工具npm install gitbook-cli -g问题一：gitbook : 无奈加载文件×××××××××因为在此零碎上禁止运行脚本。解决问题一： 关上Windows PowerShell ISE 在搜寻框内搜寻windows powershell ise，而后右击以管理员身份运行；Set-ExecutionPolicy RemoteSigned，抉择全是即可。2. 装置GitBookgitbook -V输出上述指令，会主动下载GitBook；问题二：TypeError: cb.apply is not a function解决问题二：点击链接中提醒的文件后对文件进行编辑并正文掉上面几行代码即可 3.GitBook我的项目初始构建gitbook init 执行上述命令后，会主动生成两个必要的文件 README.md 和 SUMMARY.md。 README.md: 书的介绍文字，如前言、简介，在章节中也可做为章节的简介。 SUMMARY.md: 定制书籍的章节构造和程序。此时若呈现如下问题，则是node版本的问题： 4.GitBook依赖下载gitbook install 5.GitBook插件配置及下载在book.json文件"pluginsConfig"中配置所须要的插件（记得援用前下载）。罕用插件及详解笔者的配置如下： "pluginsConfig": { "prism": { "css": [ "prismjs/themes/prism.css" ] }, "insert-logo": { "url": "/logoPic/logo.png", "style": "background:none;max-height:129px;margin-right:200px" }, "github": { "url": "https://github.com/zhangjikai" }, "hide-element": { "elements": [ ".gitbook-link" ] }, "download-pdf-link": { "base": "https://www.gitbook.com/book/poppy-project/poppy-docs/", "label": { "en": "Download PDF", "fr": "Télécharger le PDF" } } }5.GitBook目录配置 ...

gitbook残缺装置依赖的软件比拟多： nodejs 依赖环境,gitbook命令行基于nodejsnvm 治理nodejs多版本,gitbook依赖的nodejs版本比拟老，可能与零碎已有的抵触gitbook-cli 主程序gitbookcalibre 生成epub、pdf上面具体介绍在本地如何装置 GitBook。 最终装置的gitbook版本： $ gitbook -VCLI version: 2.3.2GitBook version: 3.2.3环境要求NodeJS(v4.0.0及以上)， 举荐v10.21.0 ， 其余版本可能会不兼容。gitbook曾经不更新了。如果本地已有版本，举荐装置nvm：https://www.jianshu.com/p/624... # nvm: https://github.com/nvm-sh/nvm curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash # fast by gitee with 52fhy curl -o- https://gitee.com/52fhy/nvm/raw/v0.39.1_gitee/install.sh | bash默认会在零碎的bash配置里写入环境变量，新建一个窗口就能够应用nvm命令了。如果没有失效，能够按装置提醒受到设置环境变量: => Appending nvm source string to /home/yjc/.zshrc=> Appending bash_completion source string to /home/yjc/.zshrc=> Close and reopen your terminal to start using nvm or run the following to use it now:export NVM_DIR="$HOME/.config/nvm"[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion接着就能够失常应用nvm了： ...

你好，我是悦创。 首发博客：https://www.aiyc.top/1947.html 具体的记录了一步步搭建本人的电子文档笔记1. 环境搭建1.1 装置 Nodejs大佬级别间接看上面这句话，就没啥问题： 这个装置很简略，只须要下载，而后一路 next 即可。下载链接：https://nodejs.org/en/ 小白持续看看下来： 用于所有支流平台的官网软件包，可拜访 http://nodejs.cn/download/ 装置 Node.js 的其中一种十分便捷的形式是通过软件包管理器。 对于这种状况，每种操作系统都有其本身的软件包管理器。 在 macOS 上，Homebrew 是业界的规范，在装置之后能够十分轻松地装置 Node.js（通过在 CLI 中运行以下命令）： brew install node其余实用于 Linux 和 Windows 的软件包管理器列出在 https://nodejs.org/en/download/package-manager/。 nvm 是一种风行的运行 Node.js 的形式。 例如，它能够轻松地切换 Node.js 版本，也能够装置新版本用以尝试并且当呈现问题时轻松地回滚。 这对于应用旧版本的 Node.js 来测试代码十分有用。 详见 https://github.com/creationix/nvm。 倡议，如果刚入门并且还没有用过 Homebrew，则应用官网的安装程序，否则，Homebrew 是更好的解决方案。 无论如何，当装置 Node.js 之后，就能够在命令行中拜访 node 可执行程序。 1.2 gitbook-cli 脚手架装置命令装置npm install -g gitbook-cli版本验证# gitbook -VCLI version: 2.3.2GitBook version: 3.2.3编译器的抉择:举荐上面两个vscodeTyporasublimeText32. 创立目录，初始化mkdir gitbook-imsdk // 创立我的项目目录cd gitbook-imsdkgitbook init // 初始化目录PS: 如果初始化报错的话： ...

装置装置命令：1 npm install -g gitbook-cli test装置实现之后，你能够应用上面的命令来测验是否装置胜利。 $ gitbook -VCLI version: 2.3.2GitBook version: 3.2.3应用初始化 gitbook init GitBook 筹备工作做好之后，咱们进入一个你要写书的目录，输出如下命令。 $ gitbook initwarn: no summary file in this bookinfo: create README.mdinfo: create SUMMARY.mdinfo: initialization is finished能够看到他会创立 README.md 和 SUMMARY.md 这两个文件，README.md 应该不生疏，就是阐明文档，而 SUMMARY.md 其实就是书的章节目录，其默认内容如下所 # Summary如果曾经初始化，间接启动即可- `启动本地服务 gitboook serve` 接下来，咱们输出 `$ gitbook serve` 命令，而后在浏览器地址栏中输出 `http://localhost:4000`- 新建目录首先咱们来看一下gitbook目录构造及相干文件book.json 次要寄存配置信息 { "plugins": [ "collapsible-menu", "anchor-navigation-ex", "tbfed-pagefooter", "disqus" ], "title": "公布业务逻辑梳理", "pluginsConfig": { "tbfed-pagefooter": { "copyright":"Copyright &copy ershouche-FE 2019", "modify_label": "文件订正工夫：", "modify_format": "YYYY-MM-DD HH:mm:ss" }, "disqus": { "shortName": "gitbookuse" } } }SUMMARY.md Gitbook 的章节目录新增目录文件时执行gitbook init会主动创立文件到对于目录上面 留神： 最顶层的是一级目录，缩进一次的是二级目录，默认会膨胀进对应的一级目录外面，如果想创立更深层次的目录构造，就在对应的子目录上面以缩进的形式创立 该文件外面的缩进对于文档侧边栏目录的缩进<img src="https://img.58cdn.com.cn/escstatic/fecar/pmuse/publish/fabu.png" width="200" />- 构建gitbook build 执行该命令会生成一个_book文件夹，外面的内容对于生成的HTML文件## 配置book.json### 配置阐明| 变量 | 形容 || :-----------: | :----------------------------------------------------------: || root | 蕴含所有图书文件的根文件夹的门路，除了 book.json || structure | 指定自述文件，摘要，词汇表等的门路 || title | 您的书名，默认值是从 README 中提取进去的。在 GitBook.com 上，这个字段是预填的。 || description | 您的书籍的形容，默认值是从 README 中提取进去的。在 GitBook.com 上，这个字段是预填的。 || author | 作者名。在GitBook.com上，这个字段是预填的。 || isbn | 国际标准书号 ISBN || language | 本书的语言类型 —— [ISO code](https://links.jianshu.com/go?to=https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FList_of_ISO_639-1_codes) 。默认值是 `en` || direction | 文本浏览程序。能够是 rtl （从右向左）或 ltr （从左向右），默认值依赖于 language 的值。 || gitbook | 应该应用的GitBook版本，并承受相似于 `>=3.0.0` 的条件。 || links | 在左侧导航栏增加链接信息 || plugins | 要加载的插件列表([官网插件列表](https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.gitbook.com%2Fv2-changes%2Fimportant-differences%23plugins)) || pluginsConfig | 插件的配置 |### 默认插件- highlight - 语法高亮插件- search - 搜寻插件- sharing - 分享插件- font-settings - 字体设置插件- livereload - 热加载插件搜寻  字体  分享  ### 删除默认插件在平时开发中比方分享给出的都是一些国外的社交网站 对于咱们没太大用户 那么咱们能够删除默认配置在插件配置在加`-`,配置完执行`gitbook install`即可plugins: [ "-sharing"]成果如下：  右侧不再展现分享相干的按钮### 罕用配置#### 代码复制"plugins": [ "code"]成果如下：  代码复制按钮"plugins": [ "copy-code-button"]#### 目录折叠"plugins": [ "expandable-chapters"]成果如下：  "plugins": [ "expandable-chapters-small"]和下面一样都是折叠目录的，区别就是上面的箭头要细一些。成果如下：  #### 回到顶部"plugins": [ "back-to-top-button"]成果如下： #### 高级搜寻去除默认的search搜寻和lunr，在搜寻后果中，关键字会高亮；自带的 search 插件，关键字不会高亮"plugins": [ "-lunr", "-search", "search-pro" ]原生搜寻成果： 高级搜寻： 搜寻关键字高亮，反对中文、拼音和英文#### 分享分享以后页面，比默认的 sharing 插件多了一些分享形式"plugins": ["-sharing", "sharing-plus"], "pluginsConfig": { "sharing": { "douban": false, "facebook": false, "google": true, "pocket": false, "qq": false, "qzone": true, "twitter": false, "weibo": true, "all": [ "douban", "facebook", "google", "instapaper", "linkedin","twitter", "weibo", "messenger","qq", "qzone","viber","whatsapp" ] }参数配置外面true的默认展现图标，false的默认不展现；all外面的会在分享按钮的下拉列表外面全副展现进去。成果如下： 分享成果如下： #### 配置页脚"plugins": [ "tbfed-pagefooter" ], "pluginsConfig": { "tbfed-pagefooter": { "copyright":"Copyright &copy mine 2000-2020", "modify_label": "文件订正工夫：", "modify_format": "YYYY-MM-DD HH:mm:ss" } }成果如下： 

安装npm install gitbook-cli -g初始化在需要写文档的文件夹下执行 gitbook init等待初始化完成后会有两个文件 README.md #首页SUMMARY.md #左侧菜单启动gitbook serve指定端口号 gitbook serve --port 2333菜单编写SUMMARY.md基本格式如下 # 目录* [前言](README.md)* [第一章](Chapter1/README.md) * [第1节：first](Chapter1/first.md) * [第2节：second](Chapter1/senond.md) * [第3节：third](Chapter1/third.md) * [第4节：fourth](Chapter1/fourth.md)* [第二章](Chapter2/README.md)* [第三章](Chapter3/README.md)* [第四章](Chapter4/README.md)文档导出gitbook build [文档路径] [输出路径]pdf格式 gitbook pdf ./ ./mybook.pdf如果遇到以下提示 InstallRequiredError: "ebook-convert" is not installed.Install it from Calibre: https://calibre-ebook.com表示缺少ebook-convert插件 安装插件首先需要配置一下gitbook，配置文件是当前文档目录下的book.json，类似于npm的package.json文件新建book.json，需要的插件在plugins字段里，内容基本如下： { "title" : "我的文档", "theme-default": { "showLevel": true }, "plugins": ["copy-code-button"]}以copy-code-button（代码复制按钮）插件为例然后执行 gitbook install更多插件介绍点击这里 更多详情参考官方文档