UStackUStack
Quarkdown icon

Quarkdown

Quarkdown:现代开源的基于 Markdown 的排版系统,支持反应式实时预览与多 doctype 输出(论文、演示、知识库、静态网站)。

Quarkdown

什么是 Quarkdown?

Quarkdown 是一个现代、开源的基于 Markdown 的排版系统,用于以类似 LaTeX 的工作流程编写文档。其核心目的是让您使用 Markdown 创作内容,并编译成论文、演示、知识库和静态网站的格式化输出。

该网站将 Quarkdown 定位为单一创作系统,根据输出类型可替换多种工具,包括类似 LaTeX 的文档工作流程和常见的文档/wiki 格式。

主要特性

  • 以 Markdown 为先的创作方式,使用专为可读性和快速编辑设计的格式编写内容。
  • 扩展功能,提供超出纯 Markdown 的额外格式化和行为,描述为“扩展以实现更多”。
  • 通过文档“doctype”选择多种输出类型(例如 pagedplaindocsslides),针对不同交付物。
  • 反应式预览,在输入时提供实时结果,由“超快编译和实时预览”支持。
  • 脚本功能描述为“图灵完备”,旨在帮助您重用工作流程而非重复操作。

如何使用 Quarkdown

首先使用 Markdown 编写内容,然后通过 Quarkdown 的 .doctype {…} 配置选择合适的文档类型(例如,分页文章/报告、纯文本笔记/知识布局、docs 风格内容或幻灯片)。在编辑时,使用实时预览/编译反馈查看输出渲染效果。

如果需要特殊格式或重复结构,使用 Quarkdown 扩展和脚本构造(文档展示如定义函数和渲染重复块的示例),从可重用逻辑生成一致的部分。

使用场景

  • 使用分页文档类型(.doctype {paged})编写研究论文或报告,实现文章/书籍/报告风格布局。
  • 使用纯 doctype(.doctype {plain})维护个人知识库或简单静态网站,适用于笔记和直接发布。
  • 使用 docs 导向输出(.doctype {docs})构建团队 wiki 或技术文档集,适合大型知识库和文档式阅读。
  • 使用幻灯片 doctype(.doctype {slides})准备讲座材料或演讲,将内容格式化为交互式演示。
  • 通过脚本和扩展生成重复或数据式视觉结构(网站示例展示函数和带图像及元数据的重复“卡片”或块)。

常见问题

  • Quarkdown 支持哪些输出类型? 网站描述了 doctype 模式,包括分页文章/书籍/报告、纯文本笔记/简单静态网站、docs 风格知识库,以及用于讲座和演讲的幻灯片。

  • Quarkdown 提供编写时的预览吗? 是的。它宣传实时预览和快速编译,让您在输入时即可看到结果。

  • Quarkdown 兼容 LaTeX 风格工作流程吗? 页面指出 Quarkdown 可替换用于文章/书籍/报告的 LaTeX,表示它针对该文档工作流程,而非需要独立的 LaTeX 工具链。

  • 扩展和脚本的作用是什么? 扩展被描述为实现超出基本 Markdown 的格式和行为的方式,而脚本功能被描述为图灵完备,以重用工作流程逻辑并避免重复。

  • Quarkdown 是开源的吗? 是的。元描述和页面文本称其为“开源”。

替代方案

  • LaTeX/Typst 排版工具链,用于传统文档准备,当您偏好专用排版语言或生态时。
  • 文档/wiki 静态网站生成器方法(例如,“docs”类工具),如果您的主要目标是发布结构化文档,而非使用 Markdown 加多 doctype 模式的排版。
  • 基于 Markdown 的演示框架,用于幻灯片创作,如果您主要需要幻灯片而非用于论文和知识库的统一系统。
  • 通用 wiki/笔记平台,如果您想要完全托管的编辑和发布环境,而非从 Markdown 驱动的排版导向工作流程。
Quarkdown | UStack