forked from quarto-dev/quarto-web
-
Notifications
You must be signed in to change notification settings - Fork 0
/
about.qmd
72 lines (44 loc) · 5.09 KB
/
about.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
---
title: "About Quarto"
subtitle: "Open source tools for scientific and technical publishing"
---
## Goals
The overarching goal of Quarto is to make the process of creating and collaborating on scientific and technical documents dramatically better. We hope to do this in several dimensions:
- Create a writing and publishing environment with great integrated tools for technical content. We want to make authoring with embedded code, equations, figures, complex diagrams, interactive widgets, citations, cross references, and the myriad other special requirements of scientific discourse straightforward and productive for everyone.
- Help authors take full advantage of the web as a connected, interactive platform for communications, while still providing the ability to create excellent printed output from the same document source. Researchers shouldn't need to choose between LaTeX, MS Word, and HTML but rather be able to author documents that target all of them at the same time.
- Make reproducible research and publications the norm rather than the exception. Reproducibility requires that the code and data required to create a manuscript are an integrated part of it. However, this isn't often straightforward in practice---Quarto aims to make it easier to adopt a reproducible workflow than not.
Quarto is [open source software](https://quarto.org/license.html). We believe that it's better for everyone if the tools used for research and science are free and open. Reproducibility, widespread sharing of knowledge and techniques, and the leveling of the playing field by eliminating cost barriers are but a few of the shared benefits of free software in science.
## Project
At the core of Quarto is [Pandoc](https://pandoc.org), a powerful and flexible document processing tool. Quarto adds a number of facilities to Pandoc aimed at scientific and technical publishing, including:
1. Embedding code and output from Python, R, and JavaScript via integration with [Jupyter](https://jupyter.org/), [Knitr](https://yihui.org/knitr/), and [Observable](https://github.com/observablehq/).
2. A variety of extensions to Pandoc markdown useful for technical writing including cross-references, sub-figures, layout panels, hoverable citations and footnotes, callouts, and more.
3. A project system for rendering groups of documents at once, sharing options across documents, and producing aggregate output like [websites](docs/websites/website-basics.qmd) and [books](docs/books/book-basics.qmd).
Development of Quarto is sponsored by [Posit, PBC](https://www.posit.co), where we previously created a similar system ([R Markdown](https://rmarkdown.rstudio.com/)) that shared the same goals, but was targeted principally at users of the R language. The same core team works on both Quarto and R Markdown:
- J.J. Allaire ([\@jjallaire](https://github.com/jjallaire/))
- Christophe Dervieux ([\@cderv](https://github.com/cderv))
- Carlos Scheidegger ([\@cscheid](https://github.com/cscheid))
- Charles Teague ([\@dragonstyle](https://github.com/dragonstyle))
- Yihui Xie ([\@yihui](https://github.com/yihui))
With Quarto, we are hoping to bring these tools to a much wider audience.
Quarto is a registered trademark of Posit. Please see our [trademark policy](trademark.qmd) for guidelines on usage of the Quarto trademark.
## Contribute
You can contribute to Quarto in many ways:
- By opening issues to provide feedback and share ideas.
- By submitting Pull Request (PR) to fix opened issues
- By submitting Pull Request (PR) to suggest new features (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).
Please be mindful of our [code of conduct](https://github.com/quarto-dev/quarto-cli/blob/main/.github/CODE_OF_CONDUCT.md) as you interact with other community members.
### Pull Requests {.unlisted}
Pull requests are very welcome! Here's how to contribute via PR:
1. [Fork](https://github.com/quarto-dev/quarto-cli/fork) the repository, clone it locally, and make your changes in a new branch specific to the PR. For example:
``` {.bash filename="Terminal"}
# clone your fork
$ git clone https://github.com/<username>/quarto-cli
# configure for your platform (./configure.sh or ./configure.cmd for windows)
$ cd quarto-cli
$ ./configure.sh
# checkout a new branch
$ git checkout -b feature/newthing
```
2. For significant changes (e.g more than small bug fixes), ensure that you have signed the [individual](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Indiv_contrib_agreement.pdf) or [corporate](https://posit.co/wp-content/uploads/2023/04/2023-03-13_TC_Corp_contrib_agreement.pdf) contributor agreement as appropriate. You can send the signed copy to [jj\@rstudio.com](mailto:[email protected]){.email}.
3. Submit the [pull request](https://help.github.com/articles/using-pull-requests). It is ok to submit as draft in your are still working on it but would like some feedback from us. It always good to share in the open that you are working on it.
We'll try to be as responsive as possible in reviewing and accepting pull requests.