Quarkdown:一个图灵完备的 Markdown 扩展系统

Quarkdown 是一个基于 Markdown 的现代化排版系统,围绕“多功能性”这一核心理念设计,能够将项目无缝编译为适合印刷的书籍或交互式演示文稿。

它不仅继承了 CommonMark 和 GitHub Flavored Markdown(GFM) 的语法规范,还通过引入函数变量控制结构等扩展功能,打造了一个图灵完备的内容生成引擎。

Quarkdown:一个图灵完备的 Markdown 扩展系统插图

一、为什么选择 Quarkdown?

1. 图灵完备的 Markdown 扩展

Quarkdown 的一大亮点是其对 Markdown 的深度增强:

  • 支持自定义函数调用
  • 提供丰富的标准库:布局构建器、输入输出、数学运算、条件判断、循环语句等
  • 允许用户编写和共享自己的函数与库

这使得你可以在 Markdown 中实现复杂的动态内容生成,而不仅仅是静态文本。

2. 多格式输出支持

Quarkdown 不仅能生成 HTML 页面,还可以:

  • 输出 PDF 格式文档
  • 支持分页布局与幻灯片展示
  • 编译为交互式网页,实现实时预览

结合其快速编译速度与实时刷新功能,Quarkdown 成为了从写作到出版的一体化解决方案。

二、安装与使用指南

1. 安装方式

你可以通过以下方式获取 Quarkdown:

  • 下载最新稳定版本的 quarkdown.zip
  • 或使用 Gradle 构建:./gradlew distZip

解压后:

  • bin/ 目录包含可执行脚本,建议将其加入系统 PATH
  • lib/qmd/ 包含可用的标准库文件(.qmd

⚠️ 需要 Java 17 或更高版本,支持主流操作系统(Windows/macOS/Linux)

2. 创建项目

运行以下命令创建新项目:

quarkdown create [目录名]

该命令会启动交互式项目向导,自动设置元数据和初始内容。

你也可以手动创建 .qmd 文件并开始编写内容。

3. 编译项目

单个文件编译:

quarkdown c file.qmd

如果是多文件项目,请指定根文件(即包含其他文件引用的主文件)。

4. 实时预览与监听

启用实时预览:

quarkdown c file.qmd -p -w
  • -p:启用自动重载预览
  • -w:监听源文件变化并重新编译

Quarkdown 将启动本地 Web 服务器,默认端口为 8089,并在浏览器中打开文档页面。

三、常用命令与参数说明

参数含义
-p / --preview自动刷新浏览器预览
-w / --watch监听文件变化并重新编译
--pdf生成 PDF 文件
-o <dir> / --output <dir>设置输出目录(默认:./output
-l <dir> / --libs <dir>指定外部库路径(默认:<安装目录>/lib/qmd
-r <renderer> / --render <renderer>指定渲染器类型(htmlhtml-pdf
--server-port <port>自定义本地服务器端口(默认:8089
--pretty生成格式美观的代码(便于调试)
--clean编译前清空输出目录
--strict出错时强制退出程序
--no-media-storage关闭媒体资源存储
-Dloglevel=<level>设置日志级别(如 warning, info, debug)
下载地址
百度云盘
密码:frh7

评论