Documentation for iRedMail
Go to file
Zhang Huangbin 9aa9e68864 Move css/ to html/css/. 2014-09-17 13:47:00 +08:00
3-faq-howto Move images/ to html/images/. 2014-09-17 13:44:31 +08:00
4-backup-restore Typo. 2014-09-17 12:16:28 +08:00
5-troubleshooting Add title for chapter 5-troubleshooting. 2014-09-17 13:30:18 +08:00
html Move css/ to html/css/. 2014-09-17 13:47:00 +08:00
tools Move css/ to html/css/. 2014-09-17 13:47:00 +08:00
.hgignore Review: unattended.iredmail.installation.md. 2014-09-17 13:28:29 +08:00
README.md Typo. 2014-09-16 12:35:42 +08:00
URLs.md URLs.md edited online with Bitbucket 2014-09-16 09:47:02 +00:00
convert.sh Move css/ to html/css/. 2014-09-17 13:47:00 +08:00
quarantining.clean.mail.md quarantining.clean.mail.md created online with Bitbucket 2014-09-16 10:34:21 +00:00
store.spamassassin.bayes.in.sql.md store.spamassassin.bayes.in.sql.md created online with Bitbucket 2014-09-16 10:29:23 +00:00
use.or.migrate.password.hashes.md use.or.migrate.password.hashes.md created online with Bitbucket 2014-09-16 10:30:08 +00:00

README.md

如何用 Markdown 方便地整理和写作多章节文档。

  • 使用目录来区分各个章节
  • 章节的标题、介绍用目录里 _ 开头的文件来保存
- 1-introduction/
    |- _title.md
    |- _description.md
    |- 1-what_is_iredmail.md
    |- 2-why_choose_iredmail.md
    |- 3-price.md
- 2-faq/
- 3-install/
  • 使用脚本 convert.sh 转换所有 Markdown 文件为 HTML 文件:
$ bash convert.sh

convert.sh 的作用是:

  • 自动生成包含所有文档链接的总索引文件 index.html
  • 将章节按照顺序排列
  • 生成完整的索引,并列出章节目录内的所有文章