Quarkdown - 基于 Markdown 的现代排版系统

强大的输出目标

Quarkdown 支持多种输出格式，满足从静态网站到印刷级文档的各种需求

HTML 普通模式

类似 Notion/Obsidian 的连续流式排版，非常适合静态网站和知识管理

查看作者网站

HTML 分页模式

通过 paged.js 实现，非常适合论文、文章和书籍的排版

查看演示文档

HTML 幻灯片模式

通过 reveal.js 实现，非常适合交互式演示文稿

创建演示文稿

HTML 文档模式

非常适合 Wiki、技术文档和大型知识库

查看 Quarkdown Wiki

PDF 导出

HTML 支持的所有文档类型和功能在导出为 PDF 时同样受支持。无论是书籍、论文还是演示文稿，都可以高质量导出。

了解 PDF 导出

纯文本输出

除了富媒体输出，Quarkdown 还支持纯文本输出，适用于简单的文本处理和数据提取场景。

查看文档类型

与其他工具对比

Quarkdown 在多个方面超越传统排版工具，提供更现代、更灵活的解决方案

特性	Quarkdown	LaTeX	Typst	AsciiDoc	MDX
简洁易读	✓	✗	✓	✓	✓
完整文档控制	✓	✓	✓	✗	✗
脚本支持	✓	部分支持	✓	✗	✓
书籍/文章导出	✓	✓	✓	✓	第三方
演示文稿导出	✓	✓	✓	✓	第三方
静态站点导出	✓	✗	实验性	✓	✓
文档/Wiki 导出	✓	✗	✗	✓	✓
学习曲线	简单	困难	中等	简单	简单
输出目标	HTML, PDF, TXT	PDF, PostScript	HTML, PDF	HTML, PDF, ePub	HTML

代码对比示例

LaTeX 代码

\tableofcontents

\section{Section}

\subsection{Subsection}

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

\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}

Quarkdown 代码

.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)

快速上手

几分钟内开始使用 Quarkdown 创建你的第一个文档

安装方法

安装脚本 (Linux/macOS)

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

Root 权限允许脚本将 Quarkdown 安装到 /opt/quarkdown，并将其包装脚本安装到 /usr/local/bin/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 java
scoop bucket add quarkdown https://github.com/quarkdown-labs/scoop-quarkdown
scoop install quarkdown

创建项目

quarkdown create [directory]

将启动基于提示的项目向导，让你比以往更快地搭建新的 Quarkdown 项目，所有元数据和初始内容均已就绪。

了解项目创建器

编译文档

quarkdown c file.qd

运行此命令将编译给定文件并将输出保存到文件。

常用选项

• -p 或 --preview：编译后启用自动内容重新加载
• -w 或 --watch：每当源目录中的文件发生更改时重新编译
• --pdf：生成 PDF 文件

提示：结合 -p -w 即可实现实时预览！

交互式 REPL

quarkdown repl

如果你想先熟悉 Quarkdown，可以使用交互式 REPL 模式体验。

示例文档

探索 Quarkdown 的强大功能，查看实际示例和演示

Mock 示例文档

Mock 是用 Quarkdown 编写的，是该语言提供的视觉元素的全面集合，非常适合探索和理解其核心功能 — 同时还能以页面或幻灯片的形式动手实践和实验。

查看源代码查看 PDF 示例

学术论文演示

原始出处：Attention Is All You Need

Quarkdown 可以轻松处理复杂的学术论文，包括数学公式、图表、参考文献等。

图表和可视化

Quarkdown 支持创建各种图表和可视化元素，让你的文档更加生动和专业。

实时预览功能

结合实时预览、快速的编译速度和强大的 VS Code 扩展，无论是学术论文、书籍、知识库还是交互式演示文稿，Quarkdown 都能轻松胜任。

安装 VS Code 扩展

贡献

欢迎贡献！请查看 CONTRIBUTING.md 了解如何通过 issue 或 pull request 进行贡献。

查看贡献指南

赞助者

特别感谢所有支持此项目的赞助者！

成为赞助者

理念

那个可能被误认为星球的东西，实际上是一个夸克，或者更准确地说，是一个下夸克，一种构成物质主要成分的基本粒子。

这正是 Quarkdown 所基于的理念。

许可证

默认情况下，Quarkdown 及其模块采用 GNU GPLv3 许可证，但包含自己 LICENSE 文件的模块除外。

CLI（quarkdown-cli）和语言服务器（quarkdown-lsp）模块及二进制文件采用 GNU AGPLv3 许可证。