Skip to content

Commit

Permalink
Merge pull request #943 from quarto-dev/v1.4
Browse files Browse the repository at this point in the history
Quarto 1.4 Docs
  • Loading branch information
cwickham authored Jan 17, 2024
2 parents 07f8aa4 + 26eb868 commit c8138f9
Show file tree
Hide file tree
Showing 154 changed files with 3,816 additions and 1,644 deletions.

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions _freeze/docs/authoring/penguins-qmd/execute-results/html.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"hash": "2824ad66844e803d9073ac9a3449a8eb",
"result": {
"engine": "knitr",
"markdown": "---\ntitle: \"Palmer Penguins (`.qmd`)\"\n---\n\n::: {.cell}\n\n```{.r .cell-code}\nlibrary(tidyverse)\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\n── Attaching core tidyverse packages ──────────────────────── tidyverse 2.0.0 ──\n✔ dplyr 1.1.2 ✔ readr 2.1.4\n✔ forcats 1.0.0 ✔ stringr 1.5.0\n✔ ggplot2 3.4.2 ✔ tibble 3.2.1\n✔ lubridate 1.9.2 ✔ tidyr 1.3.0\n✔ purrr 1.0.1 \n── Conflicts ────────────────────────────────────────── tidyverse_conflicts() ──\n✖ dplyr::filter() masks stats::filter()\n✖ dplyr::lag() masks stats::lag()\nℹ Use the conflicted package (<http://conflicted.r-lib.org/>) to force all conflicts to become errors\n```\n\n\n:::\n\n```{.r .cell-code}\nlibrary(palmerpenguins)\n```\n:::\n\n\nData from [Palmer Penguins R package](https://allisonhorst.github.io/palmerpenguins/)\n\n\n\n::: {.cell}\n\n```{.r .cell-code}\npenguins |> count(species)\n```\n\n::: {.cell-output .cell-output-stdout}\n\n```\n# A tibble: 3 × 2\n species n\n <fct> <int>\n1 Adelie 152\n2 Chinstrap 68\n3 Gentoo 124\n```\n\n\n:::\n:::\n\n::: {.cell}\n\n```{.r .cell-code}\ncolors <- c(\"#FF8C00\", \"#A020F0\", \"#008B8B\")\n```\n:::\n\n::: {.cell}\n\n```{.r .cell-code}\nggplot(penguins, aes(body_mass_g, flipper_length_mm)) +\n geom_point(aes(color = species)) +\n scale_color_manual(values = colors) +\n theme_minimal()\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\nWarning: Removed 2 rows containing missing values (`geom_point()`).\n```\n\n\n:::\n\n::: {.cell-output-display}\n![](penguins-qmd_files/figure-html/fig-size-scatter-1.png){#fig-size-scatter width=672}\n:::\n:::",
"supporting": [
"penguins-qmd_files"
],
"filters": [
"rmarkdown/pagebreak.lua"
],
"includes": {},
"engineDependencies": {},
"preserve": {},
"postProcess": true
}
}
17 changes: 17 additions & 0 deletions _freeze/docs/authoring/penguins-qmd/execute-results/ipynb.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"hash": "7c58eb46b87208792a5f71c912c1c658",
"result": {
"engine": "knitr",
"markdown": "---\ntitle: \"Palmer Penguins (.qmd)\"\n---\n\n::: {.cell}\n\n```{.r .cell-code}\nlibrary(tidyverse)\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\n── Attaching core tidyverse packages ──────────────────────── tidyverse 2.0.0 ──\n✔ dplyr 1.1.2 ✔ readr 2.1.4\n✔ forcats 1.0.0 ✔ stringr 1.5.0\n✔ ggplot2 3.4.2 ✔ tibble 3.2.1\n✔ lubridate 1.9.2 ✔ tidyr 1.3.0\n✔ purrr 1.0.1 \n── Conflicts ────────────────────────────────────────── tidyverse_conflicts() ──\n✖ dplyr::filter() masks stats::filter()\n✖ dplyr::lag() masks stats::lag()\nℹ Use the conflicted package (<http://conflicted.r-lib.org/>) to force all conflicts to become errors\n```\n\n\n:::\n\n```{.r .cell-code}\nlibrary(palmerpenguins)\n```\n:::\n\n\nData from [Palmer Penguins R package](https://allisonhorst.github.io/palmerpenguins/)\n\n\n\n::: {.cell}\n\n```{.r .cell-code}\npenguins |> count(species)\n```\n\n::: {.cell-output .cell-output-stdout}\n\n```\n# A tibble: 3 × 2\n species n\n <fct> <int>\n1 Adelie 152\n2 Chinstrap 68\n3 Gentoo 124\n```\n\n\n:::\n:::\n\n::: {.cell}\n\n```{.r .cell-code}\ncolors <- c(\"#FF8C00\", \"#A020F0\", \"#008B8B\")\n```\n:::\n\n::: {#cell-fig-size-scatter .cell}\n\n```{.r .cell-code}\n#| label: fig-size-scatter\nggplot(penguins, aes(body_mass_g, flipper_length_mm)) +\n geom_point(aes(color = species)) +\n scale_color_manual(values = colors) +\n theme_minimal()\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\nWarning: Removed 2 rows containing missing values (`geom_point()`).\n```\n\n\n:::\n\n::: {.cell-output-display}\n![](penguins-qmd_files/figure-ipynb/fig-size-scatter-1.png){#fig-size-scatter}\n:::\n:::",
"supporting": [
"penguins-qmd_files/figure-ipynb"
],
"filters": [
"rmarkdown/pagebreak.lua"
],
"includes": {},
"engineDependencies": {},
"preserve": null,
"postProcess": false
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions _freeze/docs/authoring/tables/execute-results/html.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

15 changes: 0 additions & 15 deletions _freeze/docs/computations/ojs/execute-results/html.json

This file was deleted.

98 changes: 59 additions & 39 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ website:
- docs/authoring/tables.qmd
- docs/authoring/diagrams.qmd
- docs/authoring/videos.qmd
- text: "Jupyter Notebooks"
- text: "Embeds"
href: docs/authoring/notebook-embed.qmd
- docs/authoring/callouts.qmd
- docs/authoring/code-annotation.qmd
Expand All @@ -132,7 +132,16 @@ website:
- docs/authoring/front-matter.qmd
- docs/authoring/title-blocks.qmd
- docs/authoring/footnotes-and-citations.qmd
- docs/authoring/cross-references.qmd
- section: Cross-References
contents:
- text: Basics
href: docs/authoring/cross-references.qmd
- text: Options
href: docs/authoring/cross-reference-options.qmd
- text: Div Syntax
href: docs/authoring/cross-references-divs.qmd
- text: Custom Floats
href: docs/authoring/cross-references-custom.qmd
- docs/authoring/create-citeable-articles.qmd
- docs/authoring/appendices.qmd
- section: "Computations"
Expand All @@ -141,6 +150,8 @@ website:
- docs/computations/r.qmd
- docs/computations/julia.qmd
- docs/computations/ojs.qmd
- docs/computations/inline-code.qmd
- docs/computations/render-scripts.qmd
- docs/computations/execution-options.qmd
- docs/computations/parameters.qmd
- section: "Tools"
Expand Down Expand Up @@ -184,6 +195,7 @@ website:
- docs/output-formats/html-code.qmd
- docs/output-formats/html-themes.qmd
- docs/output-formats/html-multi-format.qmd
- docs/output-formats/html-lightbox-figures.qmd
- docs/output-formats/html-publishing.qmd
- section: "PDF"
contents:
Expand All @@ -193,6 +205,11 @@ website:
contents:
- docs/output-formats/ms-word.qmd
- docs/output-formats/ms-word-templates.qmd
- section: "Typst"
contents:
- docs/output-formats/typst.qmd
- text: "Custom Formats"
href: docs/output-formats/typst-custom.qmd
- section: "Markdown"
contents:
- docs/output-formats/gfm.qmd
Expand Down Expand Up @@ -282,6 +299,29 @@ website:
- docs/books/book-crossrefs.qmd
- text: "Customizing Output"
href: docs/books/book-output.qmd

- section: "Manuscripts"
href: docs/manuscripts/index.qmd
contents:
- text: Getting Started
href: docs/manuscripts/index.qmd
contents:
- text: "Authoring Manuscripts"
href: docs/manuscripts/authoring/jupyterlab.qmd
contents:
- text: Jupyter Lab
href: docs/manuscripts/authoring/jupyterlab.qmd
- text: VS Code
href: docs/manuscripts/authoring/vscode.qmd
- text: RStudio
href: docs/manuscripts/authoring/rstudio.qmd
- text: "Publishing Manuscripts"
href: docs/manuscripts/publishing.qmd
- text: "Next Steps"
href: docs/manuscripts/next-steps.qmd
- text: "Using Manuscripts"
href: docs/manuscripts/components.qmd

- section: "Interactivity"
contents:
- text: "Overview"
Expand Down Expand Up @@ -340,6 +380,7 @@ website:
- docs/publishing/quarto-pub.qmd
- docs/publishing/github-pages.qmd
- docs/publishing/rstudio-connect.qmd
- docs/publishing/posit-cloud.qmd
- docs/publishing/netlify.qmd
- docs/publishing/confluence.qmd
- docs/publishing/other.qmd
Expand All @@ -353,6 +394,7 @@ website:
- docs/projects/environment.qmd
- docs/projects/scripts.qmd
- docs/projects/virtual-environments.qmd
- docs/projects/binder.qmd
- section: "Advanced"
contents:
- docs/authoring/includes.qmd
Expand Down Expand Up @@ -400,31 +442,7 @@ website:
- docs/extensions/revealjs.qmd
- docs/extensions/project-types.qmd
- docs/extensions/starter-templates.qmd
- id: manuscripts
title: "Manuscripts"
style: "floating"
collapse-level: 2
align: left
contents:
- text: Manuscripts Overview
href: docs/manuscripts/index.qmd
- text: "Authoring Manuscripts"
contents:
- text: Jupyter Lab
href: docs/manuscripts/authoring/jupyterlab.qmd
- text: VS Code
href: docs/manuscripts/authoring/vscode.qmd
- text: RStudio
href: docs/manuscripts/authoring/rstudio.qmd
- text: "Publishing Manuscripts"
href: docs/manuscripts/publishing.qmd
- text: "Next Steps"
href: docs/manuscripts/next-steps.qmd
- text: "---"
- text: "Manuscript Components"
href: docs/manuscripts/components.qmd



- id: reference
title: "Reference"
collapse-level: 3
Expand All @@ -440,6 +458,8 @@ website:
href: docs/reference/formats/pdf.qmd
- text: "MS Word"
href: docs/reference/formats/docx.qmd
- text: Typst
href: docs/reference/formats/typst.qmd
- text: "OpenOffice"
href: docs/reference/formats/odt.qmd
- text: "ePub"
Expand Down Expand Up @@ -529,6 +549,8 @@ website:
href: docs/reference/projects/websites.qmd
- text: "Books"
href: docs/reference/projects/books.qmd
- text: "Manuscripts"
href: docs/reference/projects/manuscripts.qmd
- section: "More"
contents:
- text: "Dates"
Expand All @@ -537,6 +559,8 @@ website:
href: docs/reference/globs.qmd
- text: "Citations"
href: docs/reference/metadata/citation.qmd
- text: "Cross-References"
href: docs/reference/metadata/crossref.qmd
- id: prerelease
title: "Quarto 1.3"
contents:
Expand Down Expand Up @@ -578,37 +602,33 @@ website:
- text: "Dashboards"
href: docs/dashboards/index.qmd
- text: "Typst Format"
href: docs/prerelease/1.4/typst.qmd
href: docs/output-formats/typst.qmd
- section: "Cross-References"
contents:
- text: Div Syntax
href: docs/authoring/cross-references-divs.qmd
- text: Custom Types
href: docs/authoring/cross-references-custom.qmd
- text: Listings for Executable Code
href: docs/authoring/cross-references-listings.qmd
href: docs/authoring/cross-references.qmd#code-listings
- text: Callouts
href: docs/authoring/cross-references-callouts.qmd
href: docs/authoring/cross-references.qmd#callouts
- text: Behind the Scenes
href: docs/prerelease/1.4/crossref.qmd
- text: Shiny for Python
href: docs/dashboards/interactivity/shiny-python/index.qmd
- text: Jupyter Inline Execution
href: docs/prerelease/1.4/inline.qmd
- section: Script Rendering
contents:
- text: Jupyter
href: docs/prerelease/1.4/script.qmd
- text: Knitr
href: docs/prerelease/1.4/script-r.qmd
href: docs/computations/inline-code.qmd
- text: Script Rendering
href: docs/computations/render-scripts.qmd
- text: Binder Config
href: docs/prerelease/1.4/binder.qmd
href: docs/projects/binder.qmd
- text: Connect Emails
href: docs/prerelease/1.4/email.qmd
- text: Cloud Publishing
href: docs/publishing/posit-cloud.qmd
- text: Lightbox Images
href: docs/prerelease//1.4/lightbox.qmd
href: docs/output-formats/html-lightbox-figures.qmd
- text: Lua Changes
href: docs/prerelease/1.4/lua_changes.qmd
- text: AST Processing
Expand Down
5 changes: 0 additions & 5 deletions docs/_require-1.3.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +0,0 @@
::: {.callout-note}
## Quarto 1.3 Feature

This feature is new in Quarto 1.3, which you can download at <https://quarto.org/docs/download/>
:::
5 changes: 5 additions & 0 deletions docs/_require-1.4.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
::: {.callout-note}
## Quarto 1.4 Feature

This feature is new in Quarto 1.4. Download the latest version of Quarto at <https://quarto.org/docs/download/>.
:::
28 changes: 28 additions & 0 deletions docs/authoring/_cross-reference-divs-diagram.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
To create a cross-references to a diagram using div syntax, treat it like a figure. For example, @fig-simple is created using:

````markdown
::: {#fig-simple}

```{dot}
graph {
A -- B
}
```

This is a simple graphviz graph
:::
````

::: {#fig-simple .column-margin}

```{dot}
//| fig-width: 1.5
graph {
A -- B
}
```

This is a simple graphviz graph
:::

If you would rather give diagrams a label and counter distinct from figures, consider defining [Custom Cross-Reference Types](cross-references-custom.qmd).
10 changes: 10 additions & 0 deletions docs/authoring/_cross-reference-divs-figure.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
To create a cross-reference to a figure using div syntax, create a fenced div with an id starting with `fig-`, include the image followed by the caption inside the div:

````markdown
::: {#fig-elephant}

![](elephant.png)

An Elephant
:::
````
13 changes: 13 additions & 0 deletions docs/authoring/_cross-reference-divs-listing.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
To create a cross-reference to a code listing using div syntax, create a fenced div with an id starting with `lst-`, include the code cell followed by the caption inside the div:

````markdown
::: {#lst-customers}

```{.sql}
SELECT * FROM Customers
```

Customers Query

:::
````
15 changes: 15 additions & 0 deletions docs/authoring/_cross-reference-divs-table.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
To create a cross-reference to a table using div syntax, create a fenced div with an id starting with `tbl-`, include the table followed by the caption inside the div:

````markdown
::: {#tbl-letters}

| Col1 | Col2 | Col3 |
|------|------|------|
| A | B | C |
| E | F | G |
| A | G | G |

My Caption

:::
````
19 changes: 19 additions & 0 deletions docs/authoring/_cross-reference-divs-video.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
To add a cross-reference to a video, use the [cross-reference div syntax](cross-references-divs.qmd) and treat it like a figure. For example,

````{.markdown shortcodes=false}
::: {#fig-cern}

{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}

The video "CERN: The Journey of Discovery"

:::

In @fig-cern...
````

Which renders as:

![](images/crossrefs-video.png){fig-alt="Screenshot that shows a YouTube video followed by the caption, 'Figure 1: The video CERN: The Journey of Discovery'. Below the caption is the text 'In Figure 1 ...'."}

If you would rather give videos a label and counter distinct from figures, consider defining [Custom Cross-Reference Types](cross-references-custom.qmd).
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
title: Cross-Referencing Callouts
---

{{< include /docs/prerelease/1.4/_pre-release-feature.qmd >}}

To cross-reference a callout, add an ID attribute that starts with the appropriate callout prefix (see @tbl-callout-prefixes). You can then reference the callout using the usual `@` syntax. For example, here we add the ID `#tip-example` to the callout, and then refer back to it:

``` markdown
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
title: Cross-References for Executable Code Blocks
---

{{< include /docs/prerelease/1.4/_pre-release-feature.qmd >}}

To cross-reference code from an executable code block, add the code cell options `lst-label` and `lst-cap`. The option `lst-label` provides the cross reference identifier and must begin with the prefix `lst-` to be treated as a code listing. The value of `lst-cap` provides the caption for the code listing. For example:

````{.markdown}
Expand Down
Loading

0 comments on commit c8138f9

Please sign in to comment.