使用markdown编写技术文档的要求是:
-
能导出为PDF文件;
-
能编写数学公式,
-
能在保存md文件后实时看到修改后的渲染效果。
下面的几款工具都是web server,将md文档渲染为html页面, 定稿后通过浏览器的打印为PDF功能导出为PDF文件。
markmon
markmon是一款基于node的实时预览工具。
优点是配合pandoc,可以识别mathjax格式的数学公式
它本身没有markdown和mathjax parser,需要单独安装:
apt install pandoc
(pandoc内置了对mathjax的支持),
node.js
建议通过nvm
安装,这些准备好后开始安装markmon:
mkdir ~/apps/markmon
cd ~/apps/markmon
npm install markmon
在~/.bash_aliases中加入:
alias mkm="node $HOME/apps/markmon/node_modules/markmon/bin/markmon"
预览markdown文档:
mkm myfile.md
启动一个node web服务,监听localhost:3000
端口,
用浏览器打开就可以看到渲染效果了。
下面是一个示例myfile.md文件,其中的数学公式和多层列表都可以被正确解析:
# Chapter 1
This is chapter 1.
> some quotes here
Equation 1: $\Delta w_j = \eta (y^{(i)} - \hat{y}^{(i)}) x^{(i)}_j$
Equation 2: $f(x)=\sum_{n=0}^\infty\frac{f^{(n)}(a)}{n!}(x-a)^n$
Equation 3:
$$\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}$$
This is conclusion.
# Chapter 2
1. line 1
i. subline 1
i. subline 2
i. subline 3
i. subline 4
i. subline 5
i. subline 6
1. line 2
grip
grip是一个预览markdown文件的工具,
通过pip install grip
安装,字体渲染效果比markmon好,但不能识别数学公式。
这是一个Server/Client结构的应用,使用grip myfile.md
启动web服务,
保存修改后的md文件会自动在http://localhost:6419
上反映出来。
适合两个屏幕一个写md文件,一个开web browser预览效果。
配合 Dark Reader 和 Morpheon Dark 这两个Chrome插件, 浏览器也变成了暗色。
在Evince (PDF viewer)里,用快捷键Ctrl-I
切换明暗配色。