GitBook 组织 Markdown
喜欢用 Markdown 写文档,那怎么把一个个 Markdown 文档组成在一起呢?
这篇文章,分享了一个用 GitBook 来组织 Markdown 文档的办法。一起了解下吧。
Markdown 是一种轻量级标记语言。只需人们纯文本编写文档,加上点标记符号,就能转成有格式的文档(如 HTML 富文本)。已广泛应用在笔记、文档、博客、出书等。2016 年 RFC 7763 开始也引入了 MIME 类型
text/markdown
。
1 准备工具
- 安装 Node.js: https://nodejs.org/
- 安装 GitBook: https://www.npmjs.com/package/gitbook
npm install gitbook-cli -g
最终,终端里可执行 gitbook
:
$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3
2 准备文档
2.1 创建文档目录
mkdir start-gitbook
2.2 创建说明文件 README.md
README.md
是 GitBook 的必要文件
echo "# My GitBook" > README.md
2.3 创建目录文件 SUMMARY.md
SUMMARY.md
是 GitBook 的必要文件
cat <<EOF > SUMMARY.md
# Summary
This is the summary of my book.
* [section 1](section1/README.md)
* [example 1](section1/example1.md)
* [example 2](section1/example2.md)
* [section 2](section2/README.md)
* [example 1](section2/example1.md)
EOF
编辑组织已经存在的 Markdown 文档路径。新建的项目,则写预想的文档结构。
2.4 创建文档结构
依照 SUMMARY.md
,创建新项目的文档结构。
$ gitbook init
info: create section1/README.md
info: create section1/example1.md
info: create section1/example2.md
info: create section2/README.md
info: create section2/example1.md
info: create SUMMARY.md