Quarkdown是一个基于Markdown的现代排版系统,其核心设计理念强调多功能性,能够将项目无缝编译成可直接用于印刷的书籍或交互式演示文稿。这得益于其强大的图灵完备Markdown扩展,确保用户想法能自动转化为高质量输出。
Quarkdown旨在降低学习曲线,采用广为人知的Markdown语法,遵循“约定优于配置”原则,让用户快速上手。同时,它提供现代化的排版引擎和脚本层,内置丰富的自定义选项、布局控制和脚本功能,使用户能完全掌控文档或演示文稿的设计。



Quarkdown Flavor是CommonMark和GFM的扩展,为Markdown引入函数及其他语法增强功能。例如:
.somefunction {arg1} {arg2} Body argument
得益于不断扩展的标准库,其可能性几乎无限。该标准库提供布局构建器、I/O操作、数学运算、条件语句和循环等功能。开发者甚至可以在Markdown中定义自己的函数和变量,最终构建供社区使用的强大库。
.function {greet} to from: **Hello, .to** from .from!.greet {world} from:{iamgio}
这种开箱即用的脚本支持,为创建复杂且动态的内容打开了大门,这是原生Markdown难以实现的。结合实时预览、快速编译和强大的VS Code扩展,Quarkdown能轻松应对学术论文、书籍、知识库或交互式演示文稿等多种场景。
如何使用Quarkdown
Quarkdown拥有极快的编译速度和实时预览功能,让用户在输入时即可即时查看结果,非常适合灵感迸发的创作过程。完成后,支持将作品导出为高质量的PDF或HTML文档。
安装指南
在Linux或macOS系统中,可以使用以下命令安装:
curl -fsSL https://raw.githubusercontent.com/quarkdown-labs/get-quarkdown/refs/heads/main/install.sh | sudo env "PATH=$PATH" bash
在macOS(使用Homebrew)中,安装命令为:
brew tap quarkdown-labs/quarkdown
brew install quarkdown-labs/quarkdown/quarkdown
在Windows(使用Scoop)上,安装过程同样简单:
scoop bucket add javas
scoop bucket add quarkdown https://github.com/quarkdown-labs/scoop-quarkdown
scoop install quarkdown
注意:安装需要root权限,以便将Quarkdown安装到/opt/quarkdown目录,并将包装脚本安装到/usr/local/bin/quarkdown目录。如果系统缺少Java 17、Node.js和npm,除非使用--no-pm参数,否则包管理器会自动安装这些依赖。
运行quarkdown create [目录]命令时,将启动基于提示符的项目向导,帮助用户以前所未有的速度设置新Quarkdown项目,所有元数据和初始内容都已预设。有关项目创建工具的更多信息,可参考文末资料。
参考资料