# Markdown Lab

**Repository Path**: tinylab/markdown-lab

## Basic Information

- **Project Name**: Markdown Lab
- **Description**: Markdown 实验室 —— 提供了制作幻灯、文章、书籍和简历的模板，能轻松生成 pdf 和 html，支持加密和水印。社区制作了多款免安装的随身Linux系统盘，某宝检索”泰晓 Linux"快速体验
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: http://tinylab.org/markdown-lab
- **GVP Project**: No

## Statistics

- **Stars**: 90
- **Forks**: 8
- **Created**: 2019-06-20
- **Last Updated**: 2025-06-12

## Categories & Tags

**Categories**: markdown-utils

**Tags**: None

## README


# Markdown Lab

Markdow 文档撰写环境，支持幻灯片、书籍、简历和文章。

![Markdown Lab Demo](images/markdown-lab-demo.jpg)

## 准备

在非 Ubuntu 平台，请提前自行安装好 docker，可参考 [Docker for Mac](https://docs.docker.com/docker-for-mac/)、[Docker for Windows](https://docs.docker.com/docker-for-windows/)。

如果是老版本的 Windows，可以用 [Docker Toolbox](https://docs.docker.com/toolbox/overview/)，也可以通过 Virtualbox 或 Vmware 自行安装 Ubuntu。

国内的同学请**务必**使用国内的 Docker 镜像服务，否则无法正常下载镜像，推荐参考 [阿里云镜像配置文档](https://help.aliyun.com/document_detail/60750.html)。

下面的链接是大家成功运行过 Linux Lab 的主机环境，欢迎参考，安装完以后也欢迎登记上来。

## 下载与安装

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

## 用法

### 幻灯片

    // 进入模板目录
    $ cd slides/

    // 按照 markdown 语法进行修改
    $ vim slides.md

    // 默认编译，不加水印和密码
    $ make

    // 加水印
    $ make WATERMARK=markdown-lab

    // 加密，设置相同加密密码
    $ make ENCRYPT=markdown-lab

    // 加密作者和读者设置不同加密密码
    $ make OWNERPW=markdown-lab USERPW=tinylab.org

可参考 `slides/doc/` 在 Makefile 中调整风格、颜色、字体等。

可通过 `fc-list` 查看已经安装的字体。

### 简历

    $ cd resume/
    $ make

如果没有头像照片（gravatar.jpg），会自动根据邮箱地址从 gravatar 站点取，可关闭该性能。

    $ GRAVATAR_OPTION=--no-gravatar make

简历也支持添加水印和查看密码，用法同幻灯片。

### 文章

    $ cd article/
    $ make

文章也支持添加水印和查看密码，用法同幻灯片。

### 书籍

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

## 参考资料

* [Markdown 基本语法](https://www.markdownguide.org/basic-syntax)
* [Pandoc's Markdown 语法](https://pandoc.org/MANUAL.html#pandocs-markdown)