借力 markdown-lab 沉浸式撰写文档

By Falcon of TinyLab.org 2016-08-02 14:04:10

简介

不知不觉已使用 Markdown 很多年，从早期的 M$ Office，到 LibreOffice，到 Latex，Html，以及各类在线文本编辑工具，再到如今的 Markdown，才终于找到了文档编辑的最佳助手。

Markdown 本质上彻底解决了内容和样式的纠缠，让我们在撰写内容的时候可以更加专注。至于样式，Markdown 的简洁使得样式的呈现手段多样而且便利，最出名的辅助工具当属 Pandoc，它可以把 Markdown 转换为包括 Latex, Html, pdf 等各种其他的文档表现形式：pandoc-templates。

早期用 Markdown 完成了文章、幻灯片、简历和书籍的撰写，相比其他的编辑工具而言，它的每个体验都令人畅快淋漓：

• 用 Markdown 写文档
• 用 Markdown 制作简历
• 用 Markdown 高效地写幻灯片
• Docker 快速上手：用 Docker + GitBook 写书

但是，令人不堪地是，每次更换系统或者升级电脑，要安装配套的工具还是相当繁琐的。所以，为了消除这些烦恼，Docker 就派上用场了。

这不，实在是忍受不了，前几天赶紧基于 Docker 创建了一套 Markdown Lab，把所有的环境安装过程简化成一条 Linux 命令，并且为上述每种文档样式提供了预制模板，而且很方便设计师们介入进行模板深度定制。

有了这套 Lab，在省掉很多心力的同时，可以让我们更多地沉浸于内容的创作之中。

用法

下面稍微介绍一下超级简单的用法，更多用法请参考：README.md。

准备

以 Ubuntu 为例，其他 Linux, Mac OSX，Windows 10 系统请先安装 Docker CE。老版本的 Windows 系统，请先下载并安装 Docker Toolbox。

安装完 docker 后如果想免 sudo 使用 linux lab，请务必把用户加入到 docker 用户组并重启系统。

$ sudo usermod -aG docker $USER

由于 docker 镜像文件比较大，有 1G 左右，下载时请耐心等待。另外，为了提高下载速度，建议通过配置 docker 更换镜像库为本地区的，更换完记得重启 docker 服务。

• 阿里云 Docker 镜像使用文档
• USTC Docker 镜像使用文档

下载

$ git clone https://gitee.com/tinylab/cloud-lab.git
$ cd cloud-lab/ && tools/docker/choose markdown-lab

安装

Docker 安装/启动：

$ tools/docker/pull         # Pull from docker hub

$ tools/docker/run

使用

幻灯片

$ cd slides/
$ make

如果想调整内容主题（theme）和颜色风格（colortheme），可参考 slides/doc/ 并在 Makefile 中配置 latex_theme 和 latex_colortheme。

对于字体，则可打开 templates/zh_template.tex 并对 \set*font 指定的字体进行配置。字体可从 fc-list 结果中选择。

简历

$ cd resume/
$ make

如果没有明确指明 gravatar.jpg，在配置了邮件地址后，如果存在的话，会自动从 gravatar.com 加载头像。

可通过如下方式禁止自动加载：

$ GRAVATAR_OPTION=--no-gravatar make

对于字体，可类似上面进行配置，但是配置文件在：templates/header.tex。

文章

$ cd article/
$ make

字体配置同上，也是在 templates/header.tex。

书籍

$ git submodule update --init book
$ cd book/
$ gitbook install
$ make

字体配置可通过 book.json 的 fontFamily 实现。