Quarkdown icon

Quarkdown

Quarkdown 是一款开源的 Markdown 排版系统,可用于创建论文、演示文稿、知识库和静态网站。支持命令行工作流、实时预览、HTML 输出和 PDF 导出。

Quarkdown

概览

Quarkdown 是一款基于 Markdown 的排版系统,可用于创建论文、演示文稿、知识库和静态网站。它被介绍为一款开源工具,将 Markdown 写作与额外的文档结构、版式和发布功能结合在一起。

该产品专为命令行工作流设计:创建项目、编辑 `.qd` 文件、编译,并可选择实时预览更改或导出为 PDF。来源材料将 Quarkdown 展示为一款可用于多种文档格式的单一工具,包括连续笔记、分页文档、幻灯片和文档风格站点。

功能

Markdown 加自定义文档逻辑

使用 Markdown 编写,然后通过 Quarkdown 特定语法来使用函数、变量、容器、盒子和可复用元素。快速入门展示了带命名和位置参数的函数调用,以及用 `.function` 构建的自定义组件。

HTML 和 PDF 输出

可从命令行编译为 HTML 并导出为 PDF。快速入门显示 `quarkdown c main.qd` 用于 HTML 输出,`quarkdown c main.qd --pdf` 用于 PDF 导出。

响应式实时预览

在编写时实时预览更改。快速入门说明 `-p -w` 会自动打开浏览器,方便你在编辑时查看结果。

多种文档布局

可根据不同发布目标选择多种文档类型。wiki 列出了 `plain`、`paged`、`slides` 和 `docs`,分别覆盖笔记、分页文档、演示文稿和文档站点。

图形和公式

使用具备文档感知能力的语法控制图形和公式。快速入门记录了图片尺寸、图注、独立图形,以及用于行内和独立显示数学公式的 TeX 公式语法。

适合代理的工作流

使用内置的代理技能和离线 wiki 进行辅助创作。博客称 Quarkdown 随附适用于代理的技能,以及其 wiki 和 API 参考的离线副本,方便查询。

使用场景

  • 学术与报告写作

    在 Markdown 中起草论文或报告,同时仍可控制页面布局、图形和公式。分页文档类型面向传统文档输出和 PDF 导出。

  • 文档与知识库

    使用文档风格布局和侧边栏导航构建内部 wiki、知识库或静态文档站点。来源将此格式定位为适合大型知识库和 wiki。

  • 演示与讲座

    无需切换到单独的演示工具即可创建幻灯片或讲义材料。slides 文档类型适用于交互式演示和演讲。

  • 笔记与个人知识管理

    以类似 Notion 或 Obsidian 等笔记应用的连续流布局保存笔记。plain 文档类型被描述为适合知识管理和网页浏览。

  • 预览到发布工作流

    借助实时预览和 CLI 编译循环快速迭代,然后将完成结果导出为 HTML 或 PDF。这适合希望使用单一源格式进行预览和发布的用户。

Pros and Cons

Pros

  • 开源且基于 Markdown,使写作模型对许多用户来说都很熟悉。
  • 支持多种输出样式,包括纯笔记、分页文档、幻灯片和文档站点。
  • 包含实时预览和命令行编译,便于迭代写作。
  • 提供函数、变量、图片尺寸、图形和 TeX 公式等文档特定能力。
  • 提供代理技能和离线参考资料,支持 AI 辅助创作。

Cons

  • 收集到的定价页面返回 404,因此在现有来源中无法确认托管定价、方案或商业打包信息。
  • 快速入门涵盖了核心用法,但所提供来源中的更广泛文档并不完整,因此部分功能和集成在这里无法验证。

FAQ

Quarkdown 可以创建哪些类型的文档?

Quarkdown 旨在通过 Markdown 创建文档,并结合额外的排版和布局功能。来源强调其适用于论文、演示文稿、知识库和静态网站。

如何开始一个新的 Quarkdown 文档?

快速入门展示了命令行工作流:先用 `quarkdown create` 创建项目,编辑生成的 `.qd` 文件,然后用 `quarkdown c` 进行编译。它还支持通过 `-p -w` 进行实时预览,以及使用 `--pdf` 导出 PDF。

Quarkdown 支持哪些文档布局?

快速入门列出了 `plain`、`paged`、`slides` 和 `docs` 作为文档类型。它们分别对应连续笔记、分页文档、演示文稿和文档风格站点。

Quarkdown 使用纯 Markdown,还是添加了更多语法?

来源表明 Quarkdown 建立在 Markdown 之上,并包含 GitHub Flavored Markdown 扩展。它还增加了自己的函数、变量、图形、图片大小控制和 TeX 公式语法。

是否有可用的定价信息?

主页和博客将 Quarkdown 描述为开源项目,但所收集来源中的定价页面为 404,因此这里无法确认任何托管定价或套餐详情。

Quick Facts

类别
排版系统
主要界面
命令行工作流
来源域名
quarkdown.com
文档类型
plain, paged, slides, docs
输出格式
HTML 和 PDF
许可证/定位
开源