gitbook组织管理书写

时间:2021-12-01 16:36:28

1、git

强大的版本管理工作,也适合对书写内容的更新管理。

2、markdown

git管理文本,所以书写要从docx格式转变成markdown.

而typora是一个比较好用markdown书写工具,还提供的markdown转docx等功能。

3、gitbook

是组织文本结构的。还可以预览、制作电子书。

 

gitbook使用过程:

1、安装,全局安装

npm install -g gitbook-cli

2、开始,文档组织

gitbook init

在对应目录下,执行该命令,回生成README.md 和 SUMMARY.md

  • 最重要的就是SUMMARY.md,书籍的目录结构在这里配置。
  • 文件格式md,markdown文件。

3、编辑文档结构

编辑 SUMMARY.md 文件,markdown链接的形式。例如:

* [前言](README.md)
* [第一章](Chapter1/README.md)
  * [第1节:衣](Chapter1/衣.md)
  * [第2节:食](Chapter1/食.md)
  * [第3节:住](Chapter1/住.md)
  * [第4节:行](Chapter1/行.md)
* [第二章](Chapter2/README.md)
* [第三章](Chapter3/README.md)
* [第四章](Chapter4/README.md)

注意的链接

再次执行gitbook init命令,会更新文档结构,生成对应的目录和文件。

4、使用markdown工具书写文档

Typora 是所见即所得(实时渲染)的 Markdown 编辑器: https://typora.io/

5、预览文本

gitbook serve
gitbook serve --port 2333

 执行该命令进行预览。

gitbook会对 Markdown 格式的文档进行转换,默认转换为 html 格式,生成文档在 _book目录下。

最后提示 “Serving book on http://localhost:4000”,打开浏览器查看。

6、自定义转换。

gitbook build [书籍路径] [输出路径]
gitbook pdf ./ ./mybook.pdf
gitbook epub ./ ./mybook.epub

7、git版本管理

文本格式,可以对这个目录用git管理版本。