Skip to content

Commit 9bb4d71

Browse files
authored
Update README.md
1 parent 10259a5 commit 9bb4d71

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
1-
# quarto-cli-pypi
1+
<!-- -*- mode: gfm -*- -->
2+
3+
# Quarto
4+
5+
Quarto is an open-source scientific and technical publishing system built on [Pandoc](https://pandoc.org). Quarto documents are authored using [markdown](https://en.wikipedia.org/wiki/Markdown), an easy to write plain text format.
6+
7+
In addition to the core capabilities of Pandoc, Quarto includes:
8+
9+
1. Embedding code and output from Python, R, Julia, and JavaScript via integration with [Jupyter](https://jupyter.org/), [Knitr](https://yihui.org/knitr/), and [Observable](https://github.com/observablehq/).
10+
11+
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.
12+
13+
3. A project system for rendering groups of documents at once, sharing options across documents, and producing aggregate output like [websites](https://quarto.org/docs/websites/) and [books](https://quarto.org/docs/books/).
14+
15+
4. Authoring using a wide variety of editors and notebooks including [JupyterLab](https://quarto.org/docs/tools/jupyter-lab.html), [RStudio](https://quarto.org/docs/tools/rstudio.html), and [VS Code](https://quarto.org/docs/tools/vscode.html).
16+
17+
5. A [visual markdown editor](https://quarto.org/docs/visual-editor/) that provides a productive writing interface for composing long-form documents.
18+
19+
Learn more about Quarto at <https://quarto.org>.
20+
21+
# Install
22+
23+
To install the latest released version of Quarto, use:
24+
25+
```bash
26+
pip install quarto-cli
27+
```
28+
29+
> **Note**
30+
The current `quarto-cli` package downloads required Quarto binary files from GitHub during installation. We are investigating providing pre-built wheel files to make installation more robust.
31+
32+
# Uninstall
33+
34+
To uninstall the `quarto-cli` package, use:
35+
36+
```bash
37+
pip uninstall jupyterlab_myst
38+
```

0 commit comments

Comments
 (0)