增加文档结构说明
parent
bae7ee6ba5
commit
0c8b8ac875
|
@ -77,6 +77,7 @@ pandoc --latex-engine=xelatex --template=pm-template input.md -o output.pdf
|
||||||
#### 文档的组织规则
|
#### 文档的组织规则
|
||||||
|
|
||||||
- 如果要创建一个大的主题就在最顶层创建一个目录;
|
- 如果要创建一个大的主题就在最顶层创建一个目录;
|
||||||
|
- 全书五大主题,每个主题一个目录,其下不再设二级目录;
|
||||||
- 所有的图片都放在最顶层的`images`目录下,原则上文章中用到的图片都保存在本地;
|
- 所有的图片都放在最顶层的`images`目录下,原则上文章中用到的图片都保存在本地;
|
||||||
- 所有的文档的文件名使用英文命名,可以包含数字和中划线;
|
- 所有的文档的文件名使用英文命名,可以包含数字和中划线;
|
||||||
- `etc`、`manifests`目录专门用来保存配置文件和文档中用到的其他相关文件;
|
- `etc`、`manifests`目录专门用来保存配置文件和文档中用到的其他相关文件;
|
||||||
|
@ -85,8 +86,8 @@ pandoc --latex-engine=xelatex --template=pm-template input.md -o output.pdf
|
||||||
|
|
||||||
1. 在该文章相关主题的目录下创建文档;
|
1. 在该文章相关主题的目录下创建文档;
|
||||||
2. 在`SUMMARY.md`中在相应的章节下添加文章链接;
|
2. 在`SUMMARY.md`中在相应的章节下添加文章链接;
|
||||||
3. 在文章相应的主题的头文档,即以该主题命名的文档中添加链接;
|
3. 执行`gitbook server`测试是否报错,访问 http://localhost:4000 查看该文档是否出现在相应主题的目录下;
|
||||||
4. 执行`gitbook server`测试是否保存,然后访问 http://localhost:4000 查看该文档是否出现在相应主题的目录下;
|
4. 提交PR
|
||||||
|
|
||||||
## 关于
|
## 关于
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue