编写文档
每篇文档就是一个 Markdown 文件,SUMMARY.md 里的链接顺序就是侧边栏的目录顺序。
新增一篇文档
- 在源码目录
/home/gitbook/docs.liliang.xyz/下新建 Markdown 文件,例如notes/nginx.md; - 在
SUMMARY.md中加上一行链接,可按缩进分层:
# 目录
* [简介](README.md)
* [运维笔记](notes/)
* [nginx](notes/nginx.md)
- 执行
bash build.sh构建发布。
注意:如果某一级目录在
SUMMARY.md里被当作可点击的分组,需要在目录下放一个同名README.md作为该分组的落地页。
支持的写法
标准 Markdown 全部可用:标题、列表、表格、代码块、引用、图片、链接。此外 GitBook 还支持:
行内代码 like this,以及多行代码块:
server {
listen 443 ssl;
server_name docs.liliang.xyz;
}
引用块适合放提示与备注。
页面之间互相引用请使用相对路径链接,例如 [构建与发布](../guide/build.md),构建后会自动转为站点内链。