diff --git a/README.md b/README.md index c25060f6..9acedbc4 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ -如何用 Markdown 来写作电子书。主要仿 gitbooks.io +如何用 Markdown 方便地整理和写作多章节文档。 -o 使用目录来区分各个章节。示例: +* 使用目录来区分各个章节 +* 章节的标题、介绍用目录里 _ 开头的文件来保存 - - 1-introduction/ - |- _title.md - |- _description.md - |- 1-what_is_iredmail.md - |- 2-why_choose_iredmail.md - |- 3-price.md - - 2-faq/ - - 3-install/ +``` +- 1-introduction/ + |- _title.md + |- _description.md + |- 1-what_is_iredmail.md + |- 2-why_choose_iredmail.md + |- 3-price.md +- 2-faq/ +- 3-install/ +``` -o 章节的介绍用目录里的 README.md 提供章节标题及章节的介绍性内容。 +最后使用脚本 convert.sh 自动生成电子书的 index.html 文件。这个脚本的作用是: -o 使用脚本 convert.sh 自动生成电子书的 index.html 文件,将章节按照顺序排列,生成完整的索引,并列出章节内部的所有文章。 +* 将章节按照顺序排列 +* 生成完整的索引,并列出章节目录内的所有文章