安装及使用:
在Linux系统中,编辑markdown可以用retext工具:
# Debian/Ubuntu
sudo apt-get install retext
retext Release-Notes.md
要将markdown文件转换成html文件,可以用discount或Python-markdown软件包提供的markdown:
# Debian/Ubuntu
sudo apt-get install discount或:
# Debian/Ubuntu
sudo apt-get install python-markdown转换工作很简单:
# 用discount提供的markdown工具
markdown -o Release-Notes.html Release-Notes.md
# 用python-markdown提供的markdown_py工具
markdown_py -o html4 Release-Notest.md > Release-Notes.html如果要生成PDF,也很简单,可以用python-pisa提供的xhtml2pdf:
# Debian/Ubuntu
sudo apt-get install python-pisa
# 将html转换成PDF
xhtml2pdf –html Release-Notes.html Release-Notes.pdf所以,你可以在文档目录下放置这样一个Makefile来自动这个过程:
# Makefile
MD = markdown
MDFLAGS = -T
H2P = xhtml2pdf
H2PFLAGS = –html
SOURCES := $(wildcard *.md)
OBJECTS := $(patsubst %.md, %.html, $(wildcard *.md))
OBJECTS_PDF := $(patsubst %.md, %.pdf, $(wildcard *.md))
all: build
build: html pdf
pdf: $(OBJECTS_PDF)
html: $(OBJECTS)
$(OBJECTS_PDF): %.pdf: %.html
$(H2P) $(H2PFLAGS) $< > $@
$(OBJECTS): %.html: %.md
$(MD) $(MDFLAGS) -o $@ $<
clean:
rm -f $(OBJECTS)这样你就可以通过简单的一个命令生成当前目录下所有md文件的pdf或html输出了:
# html 输出
make html
# pdf输出
make pdf这里有个问题是如果markdown的内容是中文,那么转换出来的html在浏览器中打开就无法自动识别编码,pdf更惨,直接是一堆乱码。这时我们可以借助markdown对html标记的支持来在markdown文件中加入编码信息。例如我们要将markdown转换为html4文件,可以在文件的开头加上meta标记,指明编码格式:
sed -i ‘1i\<meta http-equiv=”content-type” content=”text/html; charset=UTF-8″>’ *.md这样就可以了。另外,最近使用图灵社区的编辑系统时,markdown会时不时将下划线(_)当作斜体的标记,结果函数名就成了这样的:
# 实际上是ssl_use_cabundle
sslusecabundle我建议斜体字标记采用单个星号(*),加粗字体采用两个星号(**),这样使用起来就方便多了。当然,这个问题本身在于markdown说用星号或下划线都可以。但实际上,两个都支持反倒会造成一些问题。比如有的地方用下划线(__粗体__ -> 粗体),有的地方用星号(**粗体** -> 粗体),看起来反倒混乱不堪(选星号*的另一个理由是下划线在内容中出现的概率比星号高很多)。
常用语法:
*和_包裹的文本表示强调该内容,如:*强调*
**和__包裹的文本表示加粗该内容,对应HTML的<strong>,如:**加粗**
用空格包裹*和_,它就失去强调含义,成为字面上的星号或下划线
不想让Markdown解析字符就用\转义它
行内代码用反引号`包住它
# 一级标题
## 二级标题
### 三级标题(最多可到6级)
> 引用
*/+/– 无序列表(它们是等价的)
使用数字就是有序列表,无论是什么数字。所以你会钟爱在每个列表项前加个1. 的
列表项中使用引用(>),需要缩进
缩进四个空格或者一个TAB生成代码块
代码块中&,<,>会自动转换为HTML实体
Markdown不会解析代码块和行内代码中的Markdown标记
在一行里放三个或更多的*或-会得到一条水平线
链接:[链接文字](链接地址)如[an example](http://example.com/)
引用本地资源,使用相对路径:[about me](/about/)
行内图片:![Alt文字](/path/to/img.jpg “Optional title”),也可以用<img>标签
自动链接。产生一个可点击的链接:<http://example.com/>