Text Documentation Tool

之前简单的学习过了reStructuredText,对比了一下,感觉reST更加严格而Markdown更简单更易于使用。

reST的工具集是docutils,可以从sourcforge的网站上找到。但是总是被墙。Markdown的语法其实更容易被理解。而且使用起来也比较简单。但是相比reStructuredText,缺少目录功能。

1. 首先介绍命令行工具pandoc http://johnmacfarlane.net/pandoc/index.html

pandoc 可以将markdown的文本转换成包括pdf在内的多个格式

如下的命令就可以markdown转换成reStructuredText格式。

pandoc -s -t rst --toc helloworld.md -o helloworld.rst
命令行的用法参考http://johnmacfarlane.net/pandoc/demos.html 

2. Windows下的Markdown编辑器http://markdownpad.com/

关于ReStructuredText的教程这里推荐:http://sphinx-doc-zh.readthedocs.org/en/latest/rest.html

你可能感兴趣的:(Text Documentation Tool)