iamgio/quarkdown

这是什么？

核心功能

• 01在 Markdown 语法中加入函数调用、变量和脚本能力。
• 02同一份源文件可编译为 HTML、PDF、GFM Markdown 或纯文本。
• 03提供 plain、paged、slides、docs 四种 HTML 文档类型。
• 04支持实时预览，文件变化后自动重新编译。
• 05标准库包含布局构建器、数学、输入输出和条件判断等功能。
• 06默认限制对系统资源的访问权限。

适用场景

• 用 Markdown 撰写需要输出适合打印 PDF 的论文或书籍。
• 从文本源文件生成可交互的演示幻灯片。
• 维护技术文档站点或个人知识库。
• 通过单行函数调用在多个文档间复用重复内容。

快速上手

1. 1

   使用 Homebrew 安装（Linux/macOS）

   brew install quarkdown-labs/quarkdown/quarkdown
2. 2

   使用项目向导创建新项目

   quarkdown create [directory]
3. 3

   编译根源文件

   quarkdown c file.qd

使用前须知

• !采用 GPL-3.0 许可证，属于 copyleft 许可，衍生作品需以相同条款发布。
• !手动安装时，PDF 导出需要另外安装基于 Chromium 的浏览器。

收录于专题

标签

常见问题

quarkdown 是什么？

基于 Markdown 的排版系统，支持函数调用，可将同一份源文件编译为书籍、论文、幻灯片、网站或知识库。 Quarkdown 是一个基于 Markdown 的排版系统，在 CommonMark 和 GFM 的基础上加入了函数调用、变量，以及用于布局、数学、输入输出和条件判断的标准库。同一个项目可以编译为适合打印的分页文档、学术论文、连续流式的知识库、基于 reveal.js 的交互式演示文稿，或文档网站。

quarkdown 可以免费使用吗？用的什么许可证？

quarkdown 以 GPL-3.0 许可证开源。用于商业产品前，请先确认许可证条款。

quarkdown 还在维护吗？

活跃维护中。quarkdown 最近一次提交是在 2026年11月5日。

quarkdown 适合用来做什么？

用 Markdown 撰写需要输出适合打印 PDF 的论文或书籍。 从文本源文件生成可交互的演示幻灯片。 维护技术文档站点或个人知识库。 通过单行函数调用在多个文档间复用重复内容。

quarkdown 怎么安装和运行？

使用 Homebrew 安装（Linux/macOS）: brew install quarkdown-labs/quarkdown/quarkdown 使用项目向导创建新项目: quarkdown create [directory] 编译根源文件: quarkdown c file.qd

在哪里获取 quarkdown？

源代码和安装说明在 GitHub 上：https://github.com/iamgio/quarkdown