Study of Lightweight markup language

Posted on Sun 06 January 2013 in 我用(IT) • Tagged with github, markdown, reStructuredText

以前对txt2tags(moinmoin采用的语法标准)和reStructuredText的语法很熟,后来Jira升级到也支持Conflence wiki标准,于是textile【注1】也用得挺顺溜了。现在因为开始用github,另外一种轻量标记语言Markdown又走进了视野。 虽然都不复杂,但不看一下语法也是没法用的,还得占用我本就不够用的脑部存储。这些轮子的发明有些重复了。

推荐这篇语法说明,把原文翻译得比较好。

初次使用感受

段落和换行:双回车分段和txt2tags的语法一样,行尾加两个空格可以段内换行的规则挺不错的; 链接的格式比较新鲜:This link ; 表格:本身不支持,但可以用html的标记来完成; 代码:用单个或多个``把代码括起来。从在github上的效果上看与中文之间必须加空格。

引用资料

  • 轻量标记语言比较: http://en.wikipedia.org/wiki/Lightweight_markup_language ...

Continue reading

Python文档工具快速上手指南

Posted on Wed 18 August 2010 in 我用(IT) • Tagged with DocUtils, reStructuredText, rst2pdf

本文档的pdf版本下载地址

============================== Python文档工具快速上手指南 ==============================

:Auther: LiYan :Version: 1.0.0 :Date: 2010-08-18

.. contents::

Reference

背景知识

首先介绍一下reStructuredText和DocUtils。前者是一套纯文本标记语法, 后者是Python基于reStructuredText(简称ReST)文档工具。

ReST提供了一种简洁明了的文档语言,用户用这种语言写出文档, 再用DocUtils所提供的一些脚本将其转换成HTML(rst2html.py)、 Latex(rst2latex.py)、S5(rst2s5.py)等等格式。

然后rst2pdf隆重出场,利用这个工具可以把ReST格式的文本方便的转成pdf。

相关链接

Python_:

.. _Python: http://www.python.org/

来自google code的 rst2pdf_:

.. _rst2pdf: http://code.google.com/p/rst2pdf ...


Continue reading