关于 Quarto

用于科学和技术出版的开源工具

目标

Quarto 的总体目标是使创建和协作科学和技术文档的过程显著改善。我们希望在几个方面实现这一目标：

  • 创建一个具有出色集成工具的写作和出版环境，用于技术内容。我们希望使嵌入代码、方程、图形、复杂图表、交互式小部件、引用、交叉引用以及科学论述的众多其他特殊要求变得简单且高效。

  • 帮助作者充分利用网络作为连接的、交互式的通信平台，同时仍然能够从相同的文档源创建出色的印刷输出。研究人员不应在 LaTeX、MS Word 和 HTML 之间做出选择，而应能够同时针对所有这些平台创作文档。

  • 使可重复的研究和出版成为常态而非例外。可重复性要求创建手稿所需的代码和数据是其集成的一部分。然而，这在实践中并不总是直接的——Quarto 旨在使采用可重复的工作流程比不采用更容易。

Quarto 是开源软件。我们认为，如果用于研究和科学的工具是免费和开放的，这对每个人都是更好的。可重复性、广泛的知识和技术共享，以及通过消除成本障碍来平衡竞争环境，只是科学中免费软件的几个共同好处。

项目

Quarto 的核心是 Pandoc，一个强大且灵活的文档处理工具。Quarto 为 Pandoc 添加了许多功能，旨在科学和技术出版，包括：

  1. 通过与 Jupyter、Knitr 和 Observable 的集成，嵌入 Python、R 和 JavaScript 的代码和输出。

  2. 对 Pandoc Markdown 的各种扩展，对技术写作有用，包括交叉引用、子图、布局面板、可悬停的引用和脚注、标注等。

  3. 用于一次性渲染一组文档的项目系统，跨文档共享选项，并生成聚合输出，如网站和书籍。

Quarto 的开发由 Posit, PBC 赞助，我们之前创建了一个类似的系统（R Markdown），具有相同的目标，但主要针对 R 语言用户。同一个核心团队同时负责 Quarto 和 R Markdown：

通过 Quarto，我们希望将这些工具带给更广泛的受众。

Quarto 是 Posit 的注册商标。请参阅我们的商标政策，了解 Quarto 商标的使用指南。

贡献

你可以通过多种方式为 Quarto 做出贡献：

  • 通过打开问题提供反馈和分享想法。
  • 通过提交 Pull Request (PR) 来修复已打开的问题。
  • 通过提交 Pull Request (PR) 来建议新功能（在为新功能工作之前，最好先打开一个讨论问题）。

在与社区其他成员互动时，请注意我们的行为准则。

Pull Requests

非常欢迎 Pull Request！以下是如何通过 PR 贡献：

  1. Fork 仓库，在本地克隆它，并在一个特定于 PR 的新分支中进行更改。例如：

    Terminal
    # 克隆你的 fork
$ git clone https://github.com/<username>/quarto-cli

# 为你的平台配置（./configure.sh 或 ./configure.cmd 用于 Windows）
$ cd quarto-cli
$ ./configure.sh

# 检出一个新分支
$ git checkout -b feature/newthing

  2. 对于重大更改（例如，不仅仅是小错误修复），请确保你已签署个人或企业贡献者协议（视情况而定）。你可以将签署的副本发送至 。

  3. 提交拉取请求。如果你仍在进行中但希望获得我们的反馈，可以将其作为草稿提交。公开分享你正在处理的内容总是好的。

我们将尽力在审查和接受拉取请求时尽可能迅速地做出响应。