在文档处理和知识管理中,Markdown因其简洁易读的特性而广受欢迎,而PDF格式则因其广泛的兼容性和稳定性而被广泛用于文档分享和存档。然而,将Markdown文档高效地转换为PDF格式,同时保留格式和样式,一直是许多用户的需求。今天推荐一款好用的工具——mdout。它是一个用Go语言实现的Markdown转PDF命令行工具,基于headless Chrome技术,具备简单、可靠、易安装、可定制化和易拓展等特点。无论你是开发者、技术作家还是普通用户,mdout都能满足你将Markdown文档转换为PDF的需求,同时支持HTML和URL输入,提供了丰富的自定义选项,让你能够轻松生成符合个人或项目需求的PDF文档。
使用场景
技术文档编写
对于开发者和技术人员来说,编写技术文档是日常工作的一部分。使用Markdown格式编写文档既方便又高效,但有时需要将这些文档转换为PDF格式以便分享或存档。mdout能够快速将Markdown文档转换为PDF,同时保留代码块、数学公式等格式,确保技术文档的专业性和可读性。
学术写作
学术研究中,研究人员经常需要撰写论文、报告等文档,这些文档通常包含大量的数学公式和图表。mdout支持MathJax数学公式和Mermaid流程图,能够将这些复杂的内容准确地转换为PDF格式,满足学术写作的需求。
项目文档管理
在项目管理中,项目文档的整理和归档非常重要。mdout可以帮助项目团队将Markdown格式的项目文档转换为PDF格式,方便团队成员查阅和存档。同时,支持自定义主题和输出路径,使得文档管理更加灵活和高效。
4. 个人知识管理
对于个人用户来说,使用Markdown记录笔记和知识是一种常见的做法。mdout可以将这些Markdown笔记转换为PDF格式,方便用户进行知识整理和分享。支持HTML和URL输入,使得用户可以将网页内容快速转换为PDF,丰富知识库的内容。
安装步骤
mdout 的安装分为三步:
- 获取 mdout 可执行文件
- 配置 mdout 命令
- 下载 mdout 主题
1.1 脚本一键安装
自取安装包:https://pan.quark.cn/s/1e4d35cf8d4d
支持 macOS 或者 linux 、Windows系统
- mdout.linux.x86-64.tar.gz 7.82 MB
- mdout.macOS.x86-64.tar.gz 7.72 MB
- mdout_windows_x86-64.tar.gz 7.65 MB
- github # 主题包
1.2 windows配置和安装步骤
下载好 mdout_windows_x86-64.tar.gz
安装包,右键解压即可获得 mdout.exe
创建 mdout.exe
存放文件夹,例如 我的是存放电脑中的 D:\mdout
设置环境变量,右键我的电脑 -> 选择属性 -> 左边的高级系统设置
选择高级 -> 点击环境变量
找到下半部分的系统变量,双击 Path
行
在弹出来的窗口选择新建
填入mdout.exe 文件 所在路径,我这里是 D:\mdout
,然后一定要连续点完三个确定
检验是否成功打开 cmd 或者 powershell ,再或者 gitbash 都可以(推荐使用命令行的 windows 用户都至少装一个 gitbash ),输入 mdout
,看到如下输出就是成功了
1.3 linux配置和安装步骤
下载好安装包、并用tar命令解压文件
tar -xvzf mdout.linux.x86-64.tar.gz
放入系统可执行文件目录
sudo mv mdout /usr/local/bin
检验是否成功
# 看到版本号输出就成功
mdout --version
1.4 macOS配置和安装步骤
下载好安装包、并用tar命令解压文件
tar -xvzf mdout.macOS.x86-64.tar.gz
放入系统可执行文件目录
mv mdout /usr/local/bin
检验是否成功
# 看到版本号输出就成功
mdout --version
配置文件夹说明
你输入mdout
命令的时候, 会自动在用户的家目录下创建一个名为 mdout 的配置文件夹,并且在一般而言结构应该如下所示:
mdout
|-- conf.toml
|-- log
| `-- xxxx-x.log
`-- theme|-- github|-- css|-- index.html`-- lib
不同系统的家目录不同,最终导致不同平台的 mdout 配置文件夹路径不同,以下表格以用户为 jabin
举例,在不同系统的路径:
系统 | 配置文件夹路径 |
---|---|
windows | C:/Users/jabin/mdout |
linux | /home/jabin/mdout |
macOS | /Users/jabin/mdout |
初始化mdout 主题包
1.1 手动配置github主题包
假设我的电脑登录用户是jabin
参考 配置文件夹说明
中的不同平台配置文件夹路径以及文件位置,进入mdout/theme
文件夹,将下载好的 github 主题包放到到C:/Users/jabin/mdout/theme/
文件夹中。
1.1 使用帮助
每个命令行程序都有帮助文档,mdout也不例外
mdout -h
mdout --help
1.2 输入文件路径可以是相对路径
最简单的示例,默认就是转换成pdf文档
mdout 文件路径
输入文件路径可以是相对路径、文件在当前目录
mdout yourfile.md
或文件在上级目录
mdout ../yourfile.md
文件路径也可以是绝对路径
mdout /tmp/markdown/yourfile.md
1.4 输入文件类型
mdout支持许多输入类型,其中最普遍的就是markdown,但同样也支持html输入,url输入,但是注意,如果输入是url,不要忘记带上http://
markdown转换pdf
mdout yourfile.md
html转换成pdf
mdout yourfile.html
url获取数据转换成pdf
mdout http://www.baidu.com
1.5 输出文件类型
对于markdown输入,mdout支持输出中间过程的结果。但对于html输入或者url输入,它们的唯一输出结果就是pdf文件了
markdown 输出pdf(输出pdf为默认选项)
mdout youtfile.md -t pdf
mdout yourfile.md
markdown输出解析后html标签(这个选项可以得到markdown解析器的解析结果)
mdout youtfile.md -t tag
markdown输出经过处理后的完整html文件(常常用来调试主题)
mdout youtfile.md -t html
使用总结
mdout是一款功能强大、操作简单的Markdown转PDF工具。它基于headless Chrome技术,能够高效地将Markdown文档转换为PDF格式,同时支持HTML和URL输入,满足不同用户的需求。mdout的自定义主题功能允许用户根据自己的喜好调整文档的样式和格式,而易安装和易拓展的特点使得它适合各种技术水平的用户。无论是在技术文档编写、学术写作、项目文档管理还是个人知识管理中,mdout都能发挥重要作用,帮助用户高效地完成文档转换和管理任务。如果你经常需要处理Markdown文档并将其转换为PDF格式,mdout绝对值得一试的哈。
GitHub项目地址:https://github.com/JabinGP/mdout/tree/master