文档章节

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

limodou
 limodou
发布于 2013/12/22 14:41
字数 484
阅读 472
收藏 3

「深度学习福利」大神带你进阶工程师,立即查看>>>

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的效果了。

limodou

limodou

粉丝 246
博文 92
码字总数 36993
作品 6
西城
技术主管
私信 提问
加载中
此博客有 4 条评论,请先登录后再查看。
Flappy Bird(安卓版)逆向分析(一)

更改每过一关的增长分数 反编译的步骤就不介绍了,我们直接来看反编译得到的文件夹 方法1:在smali目录下,我们看到org/andengine/,可以知晓游戏是由andengine引擎开发的。打开/res/raw/at...

enimey
2014/03/04
6.1K
18
beego API开发以及自动化文档

beego API开发以及自动化文档 beego1.3版本已经在上个星期发布了,但是还是有很多人不了解如何来进行开发,也是在一步一步的测试中开发,期间QQ群里面很多人都问我如何开发,我的业余时间实在...

astaxie
2014/06/25
2.7W
22
5分钟 maven3 快速入门指南

前提条件 你首先需要了解如何在电脑上安装软件。如果你不知道如何做到这一点,请询问你办公室,学校里的人,或花钱找人来解释这个给你。 不建议给Maven的服务邮箱来发邮件寻求支持。 安装Mav...

fanl1982
2014/01/23
1.2W
7
极速博客引擎--Gor

gor 是使用 golang 实现的类Ruhoh静态博客引擎(Ruhoh like),基本兼容ruhoh 1.x规范. 相当于与ruhoh的官方实现(ruby实现), 有以下优点: 速度完胜 -- 编译wendal.net近200篇博客,仅需要1秒 安装...

wendal
2013/01/20
3.8K
0
跨平台手机应用开发--Gideros

Gideros 可以让你轻松快速创建 iOS 和 Android 应用,提供用户友好的集成开发环境,内建模拟器对应用进行不同屏幕大小、分辨率下的测试,最大的优点是可即时修改代码即时进行测试,无需编译安...

匿名
2013/02/19
2.8K
1

没有更多内容

加载失败,请刷新页面

加载更多

Vue视频播放器 vue-video-player

Vue视频播放器 vue-video-player 本篇主要记录一下 在 vue 项目中 如何使用 vue-video-player 来作为视频播放器,由于最近在做博客的 轻松一刻模块 所以拿这个尝试一下 在此纪录一下 以及遇到...

AskaJohnny
10分钟前
5
0
Python是什么,Python语言及其特点简介

虽然软件产业的历史相对于人类历史只是白驹过隙,但世界上却存在非常多的编程语言,「Python」 就是其中之一。 Python 语言算得上一门“古老”的编程语言,Python 流行这么久,必然有它的独到...

前端老司机
19分钟前
11
0
serve 和 hhtp-server 对比

两个都是一个静态资源工具 npm i serve http-server -g https://github.com/http-party/http-server#readme https://github.com/vercel/serve#readme 由于遇到了cors问题, 目前选择http-se......

阿豪boy
21分钟前
8
0
java开发之阿里云接口发送短信验证码

随着互联网的兴起,各行各业的需求都在不断的增加。随着业务的扩大,企业给用户发送短信验证码的业务,也是如火如荼。在这里,calvin给各位开发者推荐阿里云短信平台。原因有二:1.接入较简单...

Arisono
31分钟前
9
0
如何从我的应用程序在Android的网络浏览器中打开URL? - How can I open a URL in Android's web browser from my application?

问题: How to open an URL from code in the built-in web browser rather than within my application? 如何通过内置Web浏览器而不是应用程序中的代码打开URL? I tried this: 我尝试了这个...

javail
31分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部