英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

关于

Quarkdown 是一种现代基于 Markdown 的排版系统，设计为具有多功能性。它允许将单个项目无缝编译为可打印的书籍、学术论文、知识库或互动演示。所有这些都通过 Markdown 的一个功能强大的图灵完备扩展实现，确保您的想法能够自动流入文稿。

原创致谢：全注意力机制（Attention Is All You Need）

作为 CommonMark 和 GFM 的扩展而诞生，Quarkdown 风格为 Markdown 带来了 函数，以及许多其他语法扩展。

这是一个函数调用：

.somefunction {arg1} {arg2}
    主体参数

可能性无限，这要归功于不断扩展的标准库，它提供布局构建器、输入/输出、数学、条件语句和循环。

还不够吗？ 你仍然可以在 Markdown 内定义自己的函数和变量。你甚至可以为所有人创建超棒的库。

.函数 {greet}
    到 来自：
    **你好，.to** 来自 .from!

.greet {world} 来自:{iamgio}

结果：你好，世界 来自 iamgio！

这种开箱即用的脚本支持为复杂且动态的内容打开了大门，否则仅靠原生 Markdown 是无法实现的。

结合实时预览、⚡快速的编译速度和出色的编辑器支持，无论是学术论文、书籍、知识库还是互动演示，Quarkdown 都能轻松完成工作。

简而言之，Quarkdown 是...

• 熟悉： 基于众所周知的 Markdown 语法，使学习曲线平缓
• 优雅： 生成的输出匹配行业领先工具的质量
• 代理友好： 内置技能，确保您的编码代理具备地道流利性（阅读评估）
• 可定制： 完全控制文档布局、美学和属性
• 默认安全： 限制权限系统限制对系统资源的访问
• 多功能： 一个源文件可编译到多个目标
• 响应式： 低延迟实时预览，实现快速迭代。官方 Wiki（100 个子文档）约 2 秒即可编译完成
• 可重用： 重复内容可转换为一行函数调用
• 易于部署： 在 3 分钟内设置 CD 工作流（示例）

在寻找什么吗？

查看 维基 开始并了解更多关于该语言及其功能的信息！

就像你所期望的那样简单...

灵感来源：来自附近超大质量黑洞的 X 射线闪光神秘加速

...就像你所需要的那样复杂。

编辑器扩展

• VS Code
• IntelliJ IDEA（由@CarmJos非官方提供）

目标

• HTML

  • [X] 纯文本
    像 Notion/Obsidian 那样的连续流，完美适用于静态网站和知识管理 - 查看作者的个人网站。

  • [X] 分页 ^{通过 paged.js}
    适合论文、文章和书籍 - 查看演示文档。

  • [X] 幻灯片 ^{通过 reveal.js}
    适合互动演示。

  • [X] 文档
    适合维基、技术文档和大型知识库 - 查看Quarkdown 的维基。

• PDF

  • HTML 支持的所有文档类型和功能在导出为 PDF 时也同样支持。

• Markdown

  • GFM 导出。

• 纯文本

可以通过在源文件中调用.doctype 函数来设置所需的文档类型：

• .doctype {plain}（默认）
• .doctype {paged}
• .doctype {slides}
• .doctype {docs}

比较

LaTeX

Quarkdown

\tableofcontents

\section{Section}

\subsection{Subsection}

\begin{enumerate}
    \item \textbf{First} item
    \item \textbf{Second} item
\end{itemize}

\begin{center}
    This text is \textit{centered}.
\end{center}

\begin{figure}[!h]
    \centering
    \begin{subfigure}[b]
        \includegraphics[width=0.3\linewidth]{img1.png}
    \end{subfigure}
    \begin{subfigure}[b]
        \includegraphics[width=0.3\linewidth]{img2.png}
    \end{subfigure}
    \begin{subfigure}[b]
        \includegraphics[width=0.3\linewidth]{img3.png}
    \end{subfigure}
\end{figure}

.tableofcontents

# Section

## Subsection

1. **First** item
2. **Second** item

.center
    This text is _centered_.

.row alignment:{spacebetween}
    ![Image 1](img1.png)

    ![Image 2](img2.png)

    ![Image 3](img3.png)

入门

安装

安装脚本（Linux/macOS）

curl -fsSL https://raw.githubusercontent.com/quarkdown-labs/get-quarkdown/refs/heads/main/install.sh | sudo env "PATH=$PATH" bash

根权限允许脚本将 Quarkdown 安装到 /opt/quarkdown，并将其包装脚本安装到 /usr/local/bin/quarkdown。生成 PDF 所需的浏览器会自动安装。

有关更多安装选项，请查看 get-quarkdown。

Homebrew（Linux/macOS）

brew install quarkdown-labs/quarkdown/quarkdown

安装脚本（Windows）

irm https://raw.githubusercontent.com/quarkdown-labs/get-quarkdown/refs/heads/main/install.ps1 | iex

Scoop（Windows）

scoop bucket add quarkdown https://github.com/quarkdown-labs/scoop-quarkdown; scoop install quarkdown

GitHub 操作

请参阅 setup-quarkdown 以便轻松将 Quarkdown 集成到您的 GitHub 操作工作流中。

手动安装

快速开始

新用户？您将在 快速入门指南 中找到所需的一切，让您的第一个文档活起来！

创建项目

quarkdown create [directory] 将启动基于提示的项目向导，比以往更快地设置新的 Quarkdown 项目，并且所有 元数据 和初始内容已准备就绪。

编译

运行 quarkdown c file.qd 将编译指定的文件并将输出保存到文件中。

如果项目由多个源文件组成，则目标文件必须是根文件，即包含其他文件的文件。

• 如何包含其他文件？

如果你想熟悉 Quarkdown，quarkdown repl 让你可以使用交互式 REPL 模式进行测试。

选项

最常用的选项如下：

• -p 或 --preview：在编译后启用自动内容重载。

• -w 或 --watch：每次源目录中的文件发生更改时重新编译源文件。

[!提示]
结合使用 -p -w 即可实现 实时预览！

• --pdf：生成 PDF 文件。在 wiki 的 PDF 导出 页面了解更多。

完整选项列表，请查看 CLI 选项 wiki 页面。

模拟文档

Mock，用 Quarkdown 编写，是该语言提供的一个全面的视觉元素集合，非常适合探索和理解其主要特性——同时通过实际操作以页面或幻灯片形式获得具体结果来进行玩耍和实验。

• 文档的源文件可在 mock 目录中获取，并可以通过 quarkdown c mock/main.qd -p 进行编译。
• 为所有可能的主题组合生成的 PDF 产物可用，并可在 generated 仓库中查看。

贡献

欢迎贡献！请查看 CONTRIBUTING.md 以了解如何通过问题或拉取请求进行贡献。

概念

该标志类似于原始的Markdown 图标，重点突出 Quarkdown 的完整性、丰富的功能和自定义选项，这一点通过围绕球体旋转的箭头得以强调。

可能被误认为是行星的东西实际上是一个夸克，更具体地说，是一个下夸克，一种基本粒子，是物质的主要组成部分：它们赋予我们所知的每一个复杂结构生命，同时也是存在的最轻的物体之一。

这确实是Quarkdown所建立的概念。

许可证

默认情况下，Quarkdown 及其模块均采用 GNU GPLv3 许可，除非模块包含自己独立的 LICENSE 文件：CLI（quarkdown-cli）和语言服务器（quarkdown-lsp）模块及二进制文件采用 GNU AGPLv3 许可。

脚注

注释：

[1] 通过语言本身自定义文档及其输出产物属性的能力。 ↑