parm的再次介绍及如何快速体验用parm编译markdown文档

2019独角兽企业重金招聘Python工程师标准>>>

parm介绍

parm是一个将markdown文档转为html的工具，它支持象sphinx一样的目录功能，只要写一个index.md，然后按要求写目录文件，就可以把目录中列出的md文件全部处理，生成目录页，每个md生成独立的页面。同时它还提供：

• 在index.md支持多个toc(目录块)
• 每个toc块形成一个导航集，在一个集合内的文档页面顶部可以看到上一篇文章和下一篇文章，并且用键盘的光标键进行切換
• 每个文档页面会在左侧显示当前的一级和二级的目录结构，并且可以自动感知，点击后可以跳转
• 支持手机浏览（左侧的目录栏在宽度<=480px时自动隐藏）
• 支持disqus集成（或者在初始化init或者手工修改配置文件）
• 支持bootstrap和semantic风格，缺省为semantic，欢迎大家贡献更多的风格
• 可以修改页面生成的模板及css
• 使用par进行markdown解析，可以处理象github的一些标记及一些非标准的md语法

快速体验

首先安装依赖的包：

pip install par
pip install parm

然后生成一个文档目录，如doc，在这个目录下执行：

parm init
parm make

在执行 parm init 时，它是用来初始化文档相关的一些信息。执行 parm make 之后，会在当前目录下创建 html 子目录，这时已经有一个空的文档架子了。因为在 init 时会自动生成 index.md和introduction.md两个文件，你可以在后面根据需要进行修改。

进入 html 目录，双击index.html，就可以看到一个demo效果了。

这样我们没有写一行文档，就已经可以看到一个demo的效果了。

转载于:https://my.oschina.net/limodou/blog/186643