你好呀~

gitbook使用指南

一. node

  下载

  不要去node官网下载,那是最新版的,官方没提供旧版node。如果下载了最新版的还得下载一个管理node版本的工具,很麻烦且没必要。

  在这个网站下载node:https://nodejs.org/download/release/v8.9.4/,10.23及以下都可以

  

  安装

  下载完之后,傻瓜式安装即可。最好下载msi的,方便安装,自动配置环境变量。

 

  版本控制

  如果你有多个node的话,nvm可以切换不同的node版本,如:nvm use 8.0.0

 

二. gitbook

  安装

// 安装客户端
npm install gitbook-cli -g

// 查看以及安装gitbook本身(这个过程很漫长,遇到警告不要紧)
npm -V

 

三. Typora

  这是提供markdown语法的编辑器。(不要转gibookeditor,这个已经不能用了,网上的教程很多都旧了)

  下载安装

  百度搜索typora,进入typora官网下载安装即可。

 

四. 编写书本

  流程

  1. 在桌面新建文件夹并通过命令行进入
  2. gitbook init初始化gitbook,会生成两个md文件
  3. 编辑summary文档
  4. 完善sammary链接的其他文档
  5. 图片通过typora引用相对路径
  6. gitbook serve预览
  7. 没问题后gitbook build生成静态网页,或者gitbook pdf ./ui.pdf生成pdf

 

  优化

  1. 二级标题

  主标题引用分目录下的readme.md文件,没有就新建,作为主题介绍。

  二级标题直接二次回车,加引用分目录的文件即可。

 

  2. 目录折叠

  主目录下新增book.json文件,内容如下:

{
    "plugins":["expandable-chapters"]
}

  记得格式化一下。然后主目录下执行命令gitbook install,会生成node_modules文件夹,配置的插件也会自动下载到该目录下。这样就ok了,后面生成的book就是带折叠的。要使用自带的命令行执行,不要用powershell。

  这种自动折叠的更好,推荐这种。

{
    "plugins":["toggle-chapters"]
}

 

 

 

 

五. 问题汇总

  生成pdf文档遇到指令错误?

  安装calibre,再次使用生成pdf指令即可。

 

  gitbook build之后无法跳转?

  修改gitbook_目录下的theme.js,将1491行的 if (m) for (n.handler)... 中的m改为false即可。

  

 

  gitbook init之后报错?

  

  一开始执行gitbook init一直报上面这个错误,换个node版本就OK了。

 

 

posted @   测神  阅读(419)  评论(0编辑  收藏  举报
编辑推荐:
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
阅读排行:
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 地球OL攻略 —— 某应届生求职总结
· 提示词工程——AI应用必不可少的技术
· Open-Sora 2.0 重磅开源!
· 周边上新:园子的第一款马克杯温暖上架
点击右上角即可分享
微信分享提示