Quarkdown
Quarkdown 是一个基于 Markdown 的现代排版系统,允许单个项目无缝编译为印刷级书籍、学术论文、知识库或交互式演示文稿。它通过图灵完备的 Markdown 扩展引入函数、变量和标准库,并支持实时预览与快速编译。
社区作者 · zZz
它解决什么问题
Quarkdown 是一个现代化的、基于 Markdown 的排版系统,旨在实现多功能性。它允许单个项目无缝编译为印刷级书籍、学术论文、知识库或交互式演示文稿。Quarkdown 是 CommonMark 和 GFM 的扩展,称为 Quarkdown Flavor,为 Markdown 引入了函数调用、变量定义、标准库(包括布局构建器、I/O、数学、条件语句和循环)等图灵完备的脚本能力。用户可以定义自己的函数和变量,甚至创建可复用的库。
项目特点包括:熟悉(基于 Markdown 语法)、优雅(输出质量媲美行业领先工具)、对 Agent 友好(内置 skill)、可定制、默认安全(受限权限系统)、多目标(单一源文件编译为多种格式)、响应式(低延迟实时预览,官方 wiki 100+ 子文档约 2 秒编译)、可复用、易于部署(CD 工作流 3 分钟内设置)。支持编辑器扩展:VS Code 和 IntelliJ IDEA(非官方)。输出目标包括:HTML(Plain 连续流、Paged 通过 paged.js、Slides 通过 reveal.
js、Docs)、PDF、Markdown(GFM)、纯文本。通过 .doctype 函数设置文档类型。与 LaTeX、Typst、AsciiDoc、MDX 相比,Quarkdown 在简洁性、文档控制、脚本、书籍/文章导出、演示导出、静态站点导出、文档/wiki 导出等方面具有优势。安装方式包括安装脚本、Homebrew、Windows 安装脚本、Scoop、GitHub Actions 和手动安装。创建项目使用 quarkdown create,编译使用 quarkdown c file.
qd,支持 -p/--preview、-w/--watch、--pdf 等选项。Mock 文档演示了各种视觉元素,可通过 quarkdown c mock/main.qd -p 编译。许可证:默认 GNU GPLv3,CLI 和 LSP 模块为 GNU AGPLv3。
— 本文由 AI 根据公开来源辅助整理,命令、版本与许可证请在使用前到原始页面复核。
安装 / 开始使用
- 安装 Quarkdown:
Linux/macOS 安装脚本:
curl -fsSL https://raw.githubusercontent.com/quarkdown-labs/get-quarkdown/refs/heads/main/install.sh |