page_content stringlengths 0 33.5k | metadata dict |
|---|---|
The Groff (GNU troff) man page document formats consists of plain text mixed with formatting commands that produce ASCII/UTF8 for display at the terminal. Learn more about Groff at https://www.gnu.org/software/groff/groff.html.
format: man
Title & Author
title
Document title
date
Document date
author
Author... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/man.html",
"source": "https://quarto.org/docs/reference/formats/man.html"
} |
FictionBook is an open XML-based e-book format. You can learn more about FictionBook at https://en.wikipedia.org/wiki/FictionBook.
format: fb2
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for document when included in a website automatic sideb... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/fb2.html",
"source": "https://quarto.org/docs/reference/formats/fb2.html"
} |
MS Word is the word processor included with Microsoft Office. Word uses the OpenXML document format, which you can learn more about at https://en.wikipedia.org/wiki/Office_Open_XML.
See the MS Word format user guide for more details on creating MS Word output with Quarto.
format: docx
Title & Author
title
Docum... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/docx.html",
"source": "https://quarto.org/docs/reference/formats/docx.html"
} |
HTML is a markup language used for structuring and presenting content on the web. To learn more about HTML see https://en.wikipedia.org/wiki/HTML5.
See the HTML format user guide for more details on creating HTML output with Quarto.
format: html
Title & Author
title
Document title
subtitle
Identifies the subt... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/html.html",
"source": "https://quarto.org/docs/reference/formats/html.html"
} |
AsciiDoc is a text document format for writing documentation, articles, and books, ebooks, slideshows, web pages, man pages and blogs. You can learn more about AsciiDoc at https://asciidoc.org/.
format: asciidoc
format: asciidoctor
Asciidoc vs Asciidoctor Format
Pandoc includes support for both the asciidoc an... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/asciidoc.html",
"source": "https://quarto.org/docs/reference/formats/asciidoc.html"
} |
Markua is a markdown variant used by Leanpub. You can learn more about Markua at https://leanpub.com/markua/read.
format: markua
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for document when included in a website automatic sidebar menu.
... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/markdown/markua.html",
"source": "https://quarto.org/docs/reference/formats/markdown/markua.html"
} |
You can provide citation data for Quarto documents in the document front matter. The citation options are based upon the Citation Style Language (CSL) specification for items, but as YAML (rather than XML).
---
citation:
type: article-journal
container-title: ACM Transactions on Embedded Computing Systems
volume:... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/metadata/citation.html",
"source": "https://quarto.org/docs/reference/metadata/citation.html"
} |
Date Parsing
When you write a date for Quarto document, Quarto will attempt to parse a date string by trying a number of standard forms before ultimately attempting to infer the date format. Quarto will try dates formatted as follows, in the following order:
MM/dd/yyyy
MM-dd-yyyy
MM/dd/yy
MM-dd-yy
yyyy-MM-dd
dd MM yyy... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/dates.html",
"source": "https://quarto.org/docs/reference/dates.html"
} |
Overview
Use the docx format to create MS Word output. For example:
---
title: "My Document"
format:
docx:
toc: true
number-sections: true
highlight-style: github
---
This example highlights a few of the options available for MS Word output. This document covers these and other options in detail. See the ... | {
"lastmod": "2023-07-05T19:35:15.703Z",
"loc": "https://quarto.org/docs/output-formats/ms-word.html",
"source": "https://quarto.org/docs/output-formats/ms-word.html"
} |
Overview
Docusaurus is a popular markdown documentation system. Pages in Docusaurus websites are typically written in plain markdown, so don’t have a straightforward way to automatically and reproducibly incorporate computational output.
Using the Quarto docusaurus-md format, you can incorporate computational output (e... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/docusaurus.html",
"source": "https://quarto.org/docs/output-formats/docusaurus.html"
} |
Overview
Pandoc supports the use of a wide range of TeX distributions and PDF compilation engines including pdflatex, xelatex, lualatex, tectonic, and latexmk.
While you can employ whatever toolchain you like for LaTeX compilation, we strongly recommend the use of TinyTeX, which is a distribution of TeX Live that provi... | {
"lastmod": "2023-07-05T19:35:15.703Z",
"loc": "https://quarto.org/docs/output-formats/pdf-engine.html",
"source": "https://quarto.org/docs/output-formats/pdf-engine.html"
} |
Overview
Pandoc supports a huge array of output formats, all of which can be used with Quarto. To use any Pandoc format just use the format option or the --to command line option.
For example, here’s some YAML that specifies the use of the html format as well as a couple of format options:
---
title: "My Document"
form... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/all-formats.html",
"source": "https://quarto.org/docs/output-formats/all-formats.html"
} |
As a part of Quarto, we’ve developed a simple single file format that describes declarations, variables, and rules that should be layered into Scss files when compiling them into css. The basic structure of a theme file is:
A single text file that contains valid Scss
Special comments are used to denote regions of func... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-themes-more.html",
"source": "https://quarto.org/docs/output-formats/html-themes-more.html"
} |
Overview
Quarto provides a default layout for HTML pages that should work well for many documents. However, if the default layout isn’t working for your content, you can adjust it.
On this page, learn about:
The three high level layout options for your pages in Page Layout.
How to adjust the width of the individual la... | {
"lastmod": "2023-07-05T19:35:15.703Z",
"loc": "https://quarto.org/docs/output-formats/page-layout.html",
"source": "https://quarto.org/docs/output-formats/page-layout.html"
} |
Overview
Use the pdf format to create PDF output. For example:
---
title: "My document"
format:
pdf:
toc: true
number-sections: true
colorlinks: true
---
This example highlights a few of the options available for PDF output. This article covers these and other options in detail. See the PDF format referen... | {
"lastmod": "2023-07-05T19:35:15.703Z",
"loc": "https://quarto.org/docs/output-formats/pdf-basics.html",
"source": "https://quarto.org/docs/output-formats/pdf-basics.html"
} |
Overview
While markdown is the input format for Quarto, it can also in some cases be an output format (for example, if you have a website or CMS that accepts markdown as input and want to incorporate computations from Python or R).
This article covers using Quarto to generate GitHub Flavored Markdown (GFM). You might w... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/gfm.html",
"source": "https://quarto.org/docs/output-formats/gfm.html"
} |
_ Find your operating system in the table below
You can install Quarto for a single user on Linux by using the Quarto tarball and following the below set of steps.
1. Download the tarball
Terminal
wget https://github.com/quarto-dev/quarto-cli/releases/download/v^version^/quarto-^version^-linux-amd64.tar.gz
2. Ext... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/download/tarball.html",
"source": "https://quarto.org/docs/download/tarball.html"
} |
Current Release — vPre-release — vOlder Releases
_ Find your operating system in the table below
Release Notes
_ Find your operating system in the table below
Highlights
Quarto 1.4 includes the following new features:
Typst Format—Support for the typst output format. Typst is a new open-source ... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/download/index.html",
"source": "https://quarto.org/docs/download/index.html"
} |
In some cases you may want to create content that only displays for a given output format (or only displays when not rendering to a format). You can accomplish this by creating divs with the .content-visible and .content-hidden classes.
.content-visible
To make content visible only for a given format, create a div (::... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/conditional.html",
"source": "https://quarto.org/docs/authoring/conditional.html"
} |
Overview
HTML pages rendered with Quarto include a formatted appendix at the end of the article. The appendix includes sections for citations and footnotes in the document, as well the attribution information (if specified) for the document itself.
A simple example document appendix looks like:
To learn more about inc... | {
"lastmod": "2023-07-05T19:35:15.135Z",
"loc": "https://quarto.org/docs/authoring/appendices.html",
"source": "https://quarto.org/docs/authoring/appendices.html"
} |
Reveal Presentation
library(tidyverse)
library(palmerpenguins)
1penguins |>
2 mutate(
bill_ratio = bill_depth_mm / bill_length_mm,
bill_area = bill_depth_mm * bill_length_mm
)
1
Take penguins, and then,
2
add new columns for the bill ratio and bill area. | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/code-annotation-example/revealjs.html",
"source": "https://quarto.org/docs/authoring/code-annotation-example/revealjs.html"
} |
Overview
You can embed videos in documents using the {{< video >}} shortcode. For example, here we embed a YouTube video:
{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}
Videos can refer to video files (e.g. .mp4) or can be links to videos published on YouTube, Vimeo, or BrightCove.
Here are some additional exa... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/videos.html",
"source": "https://quarto.org/docs/authoring/videos.html"
} |
Callouts are an excellent way to draw extra attention to certain concepts, or to more clearly indicate that certain content is supplemental or applicable to only some scenarios.
Callout Types
There are five different types of callouts available.
note
warning
important
tip
caution
The color and icon will be different... | {
"lastmod": "2023-07-05T19:35:15.135Z",
"loc": "https://quarto.org/docs/authoring/callouts.html",
"source": "https://quarto.org/docs/authoring/callouts.html"
} |
Overview
Scholarly articles require much more detail in their front matter than simply a title and an author. Quarto provides a rich set of YAML metadata keys to describe these details. On this page, you’ll learn how to specify authors and their affiliations, article summaries like an abstract and keywords, and how to ... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/front-matter.html",
"source": "https://quarto.org/docs/authoring/front-matter.html"
} |
Overview
HTML pages rendered with Quarto include a formatted title block at the start of the article. The title block contains the title, subtitle, authors, date, doi, and abstract.
A simple example title block looks like:
The title block will automatically layout elements from the front matter of the document. If you... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/title-blocks.html",
"source": "https://quarto.org/docs/authoring/title-blocks.html"
} |
You can make it easier for others to cite your work by providing additional metadata with the YAML front-matter of your article. Citations can be provided for both articles published to the web or for articles published in journals (with or without a DOI).
Web Articles
To provide a citation for an article published to... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/create-citeable-articles.html",
"source": "https://quarto.org/docs/authoring/create-citeable-articles.html"
} |
Overview
Document language plays a role in Pandoc’s processing of most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.
Additonally, Quarto, Pandoc, and LaTeX will sometimes generate textual output that requires localization. For example, “Figure” or “List of ... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/language.html",
"source": "https://quarto.org/docs/authoring/language.html"
} |
Overview
Cross-references make it easier for readers to navigate your document by providing numbered references and hyperlinks to various entities like figures and tables. Every cross-referenceable entity requires a label (unique identifier prefixed with type e.g. #fig-element) and caption (description). For example, t... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/cross-references.html",
"source": "https://quarto.org/docs/authoring/cross-references.html"
} |
Overview
Quarto has native support for embedding Mermaid and Graphviz diagrams. This enables you to create flowcharts, sequence diagrams, state diagrams, gantt charts, and more using a plain text syntax inspired by markdown.
For example, here we embed a flowchart created using Mermaid:
```{mermaid}
flowchart LR
A[Ha... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/diagrams.html",
"source": "https://quarto.org/docs/authoring/diagrams.html"
} |
Overview
Quarto supports executable Julia code blocks within markdown. This allows you to create fully reproducible documents and reports—the Julia code required to produce your output is part of the document itself, and is automatically re-run whenever the document is rendered.
Quarto executes Julia code using the IJu... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/computations/julia.html",
"source": "https://quarto.org/docs/computations/julia.html"
} |
Overview
Quarto is a multi-language, next generation version of R Markdown from RStudio, with many new features and capabilities. Like R Markdown, Quarto uses Knitr to execute R code, and is therefore able to render most existing Rmd files without modification.
We’ll start by covering the basics of Quarto, then delve i... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/computations/r.html",
"source": "https://quarto.org/docs/computations/r.html"
} |
Overview
When rendering documents with embedded computations becomes time-consuming, you may want to consider adding an execution cache, which will store the results of cell executions so they aren’t re-executed with every document render.
Quarto integrates with the Jupyter Cache and Knitr Cache to to cache time consum... | {
"lastmod": "2023-07-05T19:35:15.263Z",
"loc": "https://quarto.org/docs/computations/caching.html",
"source": "https://quarto.org/docs/computations/caching.html"
} |
Overview
Quarto supports executable Python code blocks within markdown. This allows you to create fully reproducible documents and reports—the Python code required to produce your output is part of the document itself, and is automatically re-run whenever the document is rendered.
If you have Python and the jupyter pac... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/computations/python.html",
"source": "https://quarto.org/docs/computations/python.html"
} |
If you are an R Markdown user wondering about the relationship between Quarto and R Markdown, see also our FAQ for R Markdown Users.
What can I use Quarto for?
Quarto® is an open-source scientific and technical publishing system built on Pandoc. You can weave together narrative text and code to produce elegantly forma... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/faq/index.html",
"source": "https://quarto.org/docs/faq/index.html"
} |
This policy is adapted directly from the WordPress Foundation’s trademark policy for the WordPress and WordCamp names and logos. We admire the job that WordPress has done building a thriving open source community while at the same time making possible a wide variety of WordPress related businesses. We hope that this po... | {
"lastmod": "2023-07-05T19:35:16.055Z",
"loc": "https://quarto.org/trademark.html",
"source": "https://quarto.org/trademark.html"
} |
Welcome to Quarto®
An open-source scientific and technical publishing system
Author using Jupyter notebooks or with plain text markdown in your favorite editor.
Create dynamic content with Python, R, Julia, and Observable.
Publish reproducible, production quality articles, presentations, websites, blogs, and books in ... | {
"lastmod": "2023-07-05T19:35:16.055Z",
"loc": "https://quarto.org/index.html",
"source": "https://quarto.org/index.html"
} |
What can I use Quarto for?
Quarto® is an open-source scientific and technical publishing system built on Pandoc. You can weave together narrative text and code to produce elegantly formatted output as documents, web pages, blog posts, books and more.
Quarto sounds similar to R Markdown. What is the difference and wh... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/faq/rmarkdown.html",
"source": "https://quarto.org/docs/faq/rmarkdown.html"
} |
Output Options
There are a wide variety of options available for customizing output from executed code. All of these options can be specified either globally (in the document front-matter) or per code-block. For example, here’s a modification of the Python example to specify that we don’t want to “echo” the code into t... | {
"lastmod": "2023-07-05T19:35:15.263Z",
"loc": "https://quarto.org/docs/computations/execution-options.html",
"source": "https://quarto.org/docs/computations/execution-options.html"
} |
Overview
You may have a set of parameters that are used to create different variations of a report. For example:
Showing results for a specific geographic location.
Running a report that covers a specific time period.
Running a single analysis multiple times for different assumptions.
This article describes how to de... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/computations/parameters.html",
"source": "https://quarto.org/docs/computations/parameters.html"
} |
Overview
Quarto includes native support for Observable JS, a set of enhancements to vanilla JavaScript created by Mike Bostock (also the author of D3). Observable JS is distinguished by its reactive runtime, which is especially well suited for interactive data exploration and analysis.
The creators of Observable JS (Ob... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/computations/ojs.html",
"source": "https://quarto.org/docs/computations/ojs.html"
} |
This page documents a number of strategies you can employ in case you run into problems with Quarto. As always, we welcome feedback and bug reports on the Quarto issue tracker, but this page might help you get up and running quickly.
Basics
Check the version of quarto and its dependencies
You can check the version of... | {
"lastmod": "2023-07-05T19:35:15.859Z",
"loc": "https://quarto.org/docs/troubleshooting/index.html",
"source": "https://quarto.org/docs/troubleshooting/index.html"
} |
Overview
Includes are a convenient way to re-use content across documents. Includes work for plain markdown content as well as for .qmd files with executable code cells (note however that the cells must all use the same engine – i.e. knitr or jupyter, but not both).
To include a file, add the {{< include >}} shortcode ... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/includes.html",
"source": "https://quarto.org/docs/authoring/includes.html"
} |
Quarto 1.3 Feature
This feature is new in Quarto 1.3, which you can download at https://quarto.org/docs/download/
Overview
You can include the output of an external Jupyter notebook in a Quarto document with the embed shortcode. To embed a notebook cell, provide the path to a Jupyter Notebook and a cell identifie... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/notebook-embed.html",
"source": "https://quarto.org/docs/authoring/notebook-embed.html"
} |
Quarto 1.3 Feature
This feature is new in Quarto 1.3, which you can download at https://quarto.org/docs/download/
Overview
Code blocks and executable code cells in Quarto can include line-based annotations. Line-based annotations provide a way to attach explanation to lines of code much like footnotes.
For exampl... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/code-annotation.html",
"source": "https://quarto.org/docs/authoring/code-annotation.html"
} |
Overview
Quarto is based on Pandoc and uses its variation of markdown as its underlying document syntax. Pandoc markdown is an extended and slightly revised version of John Gruber’s Markdown syntax.
Markdown is a plain text format that is designed to be easy to write, and, even more importantly, easy to read:
A Markdo... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/markdown-basics.html",
"source": "https://quarto.org/docs/authoring/markdown-basics.html"
} |
import pandas as pd
import altair as alt
import seaborn as sns
from matplotlib import pyplot as plt
Data from Palmer Penguins R package
penguins = pd.read_csv("https://pos.it/palmer-penguins-github-csv")
penguins.groupby("species").size().reset_index(name = "count")
species
count
0
Adelie
152
1
Chinstra... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/penguins.html",
"source": "https://quarto.org/docs/authoring/penguins.html"
} |
Citations
Quarto will use Pandoc to automatically generate citations and a bibliography in a number of styles. To use this capability, you will need:
A quarto document formatted with citations (see Citation Markdown).
A bibliographic data source, for example a BibLaTeX (.bib) or BibTeX (.bibtex) file.
Optionally, a CS... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/footnotes-and-citations.html",
"source": "https://quarto.org/docs/authoring/footnotes-and-citations.html"
} |
Overview
There are a number of ways to include dynamic variables within documents rendered by Quarto. This is useful for externalizing content that varies depending on context, or as an alternative to repeating a value in multiple places (e.g. a version number).
For example, the following prints the title from document... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/variables.html",
"source": "https://quarto.org/docs/authoring/variables.html"
} |
Overview
Quarto supports a variety of page layout options that enable you to author content that:
Fills the main content region
Overflows the content region
Spans the entire page
Occupies the document margin
Quarto uses the concept of columns to describe page layout (e.g. the “body” column, the “margin” column, etc.)... | {
"lastmod": "2023-07-05T19:35:15.135Z",
"loc": "https://quarto.org/docs/authoring/article-layout.html",
"source": "https://quarto.org/docs/authoring/article-layout.html"
} |
Quarto includes a number of features aimed at making it easier to work with figures and subfigures, as well as for laying out panels that contain multiple figures, tables, or other content.
Figure Basics
In Pandoc markdown, a figure is created whenever a captioned image appears by-itself in a paragraph. For example:
!... | {
"lastmod": "2023-07-05T19:35:15.139Z",
"loc": "https://quarto.org/docs/authoring/figures.html",
"source": "https://quarto.org/docs/authoring/figures.html"
} |
Overview
Quarto includes a number of features aimed at making it easy to to author and customize markdown table output, including:
Specifying column alignment and widths.
Providing captions, subcaptions, and cross-references.
Generating tables dynamically from executable code cells.
This article covers using these fe... | {
"lastmod": "2023-07-05T19:35:15.215Z",
"loc": "https://quarto.org/docs/authoring/tables.html",
"source": "https://quarto.org/docs/authoring/tables.html"
} |
Note
Pre-release builds are intended for testing purposes, and are not recommended for general use. For stable builds, please visit Release Builds.
_ Find your operating system in the table below
Highlights
Quarto 1.4 includes the following new features:
Typst Format—Support for the typst output format. T... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/download/prerelease.html",
"source": "https://quarto.org/docs/download/prerelease.html"
} |
_ Find your operating system in the table below
Release Notes | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/download/release.html",
"source": "https://quarto.org/docs/download/release.html"
} |
Authoring
Create content with markdown
Markdown Basics
Figures
Tables
Diagrams
Citations & Footnotes
Cross References
Article Layout
Computations
Execute code and display its output
Using Python
Using R
Using Julia
Using Observable
Execution Options
Parameters
Tools
Use your favorite tools with Qua... | {
"lastmod": "2023-07-05T19:35:15.471Z",
"loc": "https://quarto.org/docs/guide/index.html",
"source": "https://quarto.org/docs/guide/index.html"
} |
Quarto 1.3 Feature
This feature is new in Quarto 1.3, which you can download at https://quarto.org/docs/download/
Overview
HTML pages (either standalone or in a website) can automatically include links to other formats specified in the document front matter. For example, the following document front matter:
title... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-multi-format.html",
"source": "https://quarto.org/docs/output-formats/html-multi-format.html"
} |
Overview
Hugo is a very popular open source website publishing system. Pages in Hugo websites are typically written in plain markdown, so don’t have a straightforward way to automatically and reproducibly incorporate computational output.
Using the Quarto hugo-md format, you can incorporate computational output (e.g. R... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/hugo.html",
"source": "https://quarto.org/docs/output-formats/hugo.html"
} |
Overview
HTML documents rendered with Quarto use Bootstrap 5 by default. This can be disabled or customized via the theme option:
theme: default # bootstrap 5 default
theme: cosmo # cosmo bootswatch theme
theme: pandoc # pandoc default html treatment
theme: none # no theme css added to document
Quarto includes 25... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-themes.html",
"source": "https://quarto.org/docs/output-formats/html-themes.html"
} |
Overview
There are wide variety of options available to customize the display of source code within HTML documents, including:
Hiding some or all code that was executed by Knitr or Jupyter.
Code folding for executed code (hidden by default and expandable by readers).
Handling code that overflows the available horizont... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-code.html",
"source": "https://quarto.org/docs/output-formats/html-code.html"
} |
Overview
Use the html format to create HTML output. For example:
---
title: "My document"
format:
html:
toc: true
html-math-method: katex
css: styles.css
---
This example highlights a few of the options available for HTML output. This document covers these and other options in detail. See the HTML format ... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-basics.html",
"source": "https://quarto.org/docs/output-formats/html-basics.html"
} |
Overview
This article covers the various ways you can publish Quarto HTML documents, including publishing to a hosting service or sharing a standalone HTML file using E-mail, Dropbox, etc.
Note that it’s also possible to publish collections of Quarto documents as a website. See the article on Publishing Basics for addi... | {
"lastmod": "2023-07-05T19:35:15.675Z",
"loc": "https://quarto.org/docs/output-formats/html-publishing.html",
"source": "https://quarto.org/docs/output-formats/html-publishing.html"
} |
Using Templates
If you want to customize the appearance of MS Word output, Pandoc supports a special type of template called a reference document. Here’s an example of specifying a custom reference document for docx:
format:
docx:
reference-doc: custom-reference-doc.docx
Reference documents include sample text th... | {
"lastmod": "2023-07-05T19:35:15.703Z",
"loc": "https://quarto.org/docs/output-formats/ms-word-templates.html",
"source": "https://quarto.org/docs/output-formats/ms-word-templates.html"
} |
Overview
Quarto sometimes allows you to provide a path or paths using glob syntax, providing wildcard expansion and other behavior that makes it simple to match a list of files without having to specify each file individually. Globs may be used:
When specifying render targets in Quarto projects (see Render Targets).
W... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/globs.html",
"source": "https://quarto.org/docs/reference/globs.html"
} |
Documents
HTML
PDF
MS Word
Open Office
ePub
Presentations
Revealjs
PowerPoint
Beamer
Markdown
GitHub
CommonMark
Markua
Wikis
MediaWiki
Jira Wiki
DokuWiki
ZimWiki
XWiki
Code Cells
Jupyter
Knitr
Observable JS
Projects
Options
Websites
Books
Metadata
Dates
Globs
Citations
... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/index.html",
"source": "https://quarto.org/docs/reference/index.html"
} |
GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. To learn about GFM see https://github.github.com/gfm/.
See the GFM format user guide for more details on creating GFM output with Quarto.
format: gfm
Title & Au... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/markdown/gfm.html",
"source": "https://quarto.org/docs/reference/formats/markdown/gfm.html"
} |
CommonMark is a strongly defined, highly compatible specification of Markdown. You can learn more about CommonMark at https://commonmark.org/.
format: commonmark
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for document when included in a webs... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/markdown/commonmark.html",
"source": "https://quarto.org/docs/reference/formats/markdown/commonmark.html"
} |
JATS (Journal Article Tag Suite) is an XML format for marking up and exchanging journal content. You can learn more about JATS here https://jats.nlm.nih.gov/publishing/.
format: jats
format: jats_archiving
format: jats_articleauthoring
format: jats_publishing
Title & Author
title
Document title
date
Document date... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/jats.html",
"source": "https://quarto.org/docs/reference/formats/jats.html"
} |
OpenDocument, is an open standard file format for word processing documents It was developed with the aim of providing an open, XML-based file format specification for office applications. To learn more about OpenDocument see https://en.wikipedia.org/wiki/OpenDocument.
format: odt
Title & Author
title
Document ... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/odt.html",
"source": "https://quarto.org/docs/reference/formats/odt.html"
} |
reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. You can learn more about reStructuredText at https://docutils.sour... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/rst.html",
"source": "https://quarto.org/docs/reference/formats/rst.html"
} |
Org-Mode is an Emacs major mode for keeping notes, authoring documents, computational notebooks, literate programming, maintaining to-do lists, planning projects, and more. To learn more about Org-Mode see https://orgmode.org/.
format: org
Title & Author
title
Document title
date
Document date
author
Author... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/org.html",
"source": "https://quarto.org/docs/reference/formats/org.html"
} |
MediaWiki is the native document format of Wikipedia. To learn more about MediaWiki see https://www.mediawiki.org.
format: mediawiki
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for document when included in a website automatic sidebar menu.
... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/wiki/mediawiki.html",
"source": "https://quarto.org/docs/reference/formats/wiki/mediawiki.html"
} |
Jira Wiki is the native document format for the Jira issue tracking and project management system from Atlassian. To learn more about Jira Wikis see https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all.
format: jira
Title & Author
title
Document title
date
Document date
author
Author or... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/wiki/jira.html",
"source": "https://quarto.org/docs/reference/formats/wiki/jira.html"
} |
Zim is a graphical text editor used to maintain a collection of wiki pages. To learn more about ZimWiki see https://zim-wiki.org/.
format: zimwiki
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for document when included in a website automatic s... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/wiki/zimwiki.html",
"source": "https://quarto.org/docs/reference/formats/wiki/zimwiki.html"
} |
Emacs Muse is an authoring and publishing environment for Emacs. It simplifies the process of writing documents and publishing them to various output formats. To learn more about Emacs Muse see https://www.gnu.org/software/emacs-muse/manual/.
format: muse
Title & Author
title
Document title
subtitle
Identifie... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/muse.html",
"source": "https://quarto.org/docs/reference/formats/muse.html"
} |
Haddock is a tool for automatically generating documentation from annotated Haskell source code. You can learn more about Haddock at https://haskell-haddock.readthedocs.io/.
format: haddock
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
order
Order for docu... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/haddock.html",
"source": "https://quarto.org/docs/reference/formats/haddock.html"
} |
PowerPoint is the presentation editing software included with Microsoft Office. You can learn more about PowerPoint at https://en.wikipedia.org/wiki/Microsoft_PowerPoint.
See the PowerPoint format user guide for more details on creating PowerPoint output with Quarto.
format: pptx
Title & Author
title
Document t... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/presentations/pptx.html",
"source": "https://quarto.org/docs/reference/formats/presentations/pptx.html"
} |
DocBook is an XML schema particularly well suited to books and papers about computer hardware and software (though it is by no means limited to these applications). You can learn more about DocBook at https://www.docbook.org/.
format: docbook
Title & Author
title
Document title
date
Document date
author
Aut... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/docbook.html",
"source": "https://quarto.org/docs/reference/formats/docbook.html"
} |
The Rich Text Format (RTF) is a proprietary document file format with published specification developed by Microsoft Corporation from 1987 until 2008 for cross-platform document interchange with Microsoft products. Learn more about RTF at https://en.wikipedia.org/wiki/Rich_Text_Format.
format: rtf
Title & Author
... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/rtf.html",
"source": "https://quarto.org/docs/reference/formats/rtf.html"
} |
ICML is an XML representation of an Adobe InDesign document. You can learn more about ICML at https://wwwimages.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-specification.pdf.
format: icml
Title & Author
title
Document title
date
Document date
author
Author or authors of the document
or... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/icml.html",
"source": "https://quarto.org/docs/reference/formats/icml.html"
} |
Texinfo is the official documentation format of the GNU project. Texinfo uses a single source file to produce output in a number of formats, both online and printed (DVI, HTML, Info, PDF, XML, etc.). To learn more about Texinfo see https://www.gnu.org/software/texinfo/.
format: texinfo
Title & Author
title
Docu... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/formats/texinfo.html",
"source": "https://quarto.org/docs/reference/formats/texinfo.html"
} |
ePub is an e-book file format that is supported by many e-readers, and compatible software is available for most smartphones, tablets, and computers. You can learn more about ePub at https://en.wikipedia.org/wiki/EPUB.
format: epub
Title & Author
title
Document title
subtitle
Identifies the subtitle of the do... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/formats/epub.html",
"source": "https://quarto.org/docs/reference/formats/epub.html"
} |
All available options for book projects are documented below. See Creating a Book for an in-depth guide to creating books with Quarto.
Project
Options that define the type, render targets, and output of a project. Project options are specified under the project key. For example:
---
project:
type: book
output-dir:... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/projects/books.html",
"source": "https://quarto.org/docs/reference/projects/books.html"
} |
This article documents options that define the type, render targets, and output of a project.
See the Project Basics article for additional documentation on using projects.
Project options are specified under the project key. For example:
---
project:
type: website
output-dir: _site
---
title
type
Project ty... | {
"lastmod": "2023-07-05T19:35:15.799Z",
"loc": "https://quarto.org/docs/reference/projects/core.html",
"source": "https://quarto.org/docs/reference/projects/core.html"
} |
Knitr is an R package for dynamic document generation. Learn more about using Knitr in the article on Using R.
Overview
Cell options affect the execution and output of executable code blocks. They are specified within comments at the top of a block. For example:
```{r}
#| label: fig-polar
#| echo: false
#| fig-cap: "A... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/cells/cells-knitr.html",
"source": "https://quarto.org/docs/reference/cells/cells-knitr.html"
} |
Jupyter is an open document format that supports computations in many languages including Python, R, and Julia. Learn more about using Jupyter with Quarto in the articles on Using Python and Using Julia.
Overview
Cell options affect the execution and output of executable code blocks. They are specified within comments... | {
"lastmod": "2023-07-05T19:35:15.795Z",
"loc": "https://quarto.org/docs/reference/cells/cells-jupyter.html",
"source": "https://quarto.org/docs/reference/cells/cells-jupyter.html"
} |
Have you been hearing about Quarto but didn’t give it a try yet? Perused the Get Started pages but would like another intro? Or have about 20 minutes to spare and want to pick up a few Quarto tips? You’ve come to the right place!
In this video, I walk you through creating documents, presentations, and websites and pub... | {
"lastmod": "2023-07-05T19:35:15.251Z",
"loc": "https://quarto.org/docs/blog/posts/2023-05-15-get-started/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-05-15-get-started/index.html"
} |
Other FormatsJupyterMS Word
Quarto 1.3 Feature
This post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.
Starting in Quarto 1.3, HTML pages (either standalone or in a website) can automatically include links to other fo... | {
"lastmod": "2023-07-05T19:35:15.223Z",
"loc": "https://quarto.org/docs/blog/posts/2023-03-15-multi-format/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-03-15-multi-format/index.html"
} |
NotebooksPalmer Penguins
Quarto 1.3 Feature
This post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.
Starting in Quarto 1.3, you can include the output of an external Jupyter notebook in a Quarto document with the embe... | {
"lastmod": "2023-07-05T19:35:15.227Z",
"loc": "https://quarto.org/docs/blog/posts/2023-03-17-jupyter-cell-embedding/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-03-17-jupyter-cell-embedding/index.html"
} |
Quarto 1.3 Feature
This post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.
Atlassian Confluence is a publishing platform for supporting team collaboration. Confluence has a variety of hosting options which include both free a... | {
"lastmod": "2023-07-05T19:35:15.247Z",
"loc": "https://quarto.org/docs/blog/posts/2023-03-20-confluence/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-03-20-confluence/index.html"
} |
The new Shinylive Quarto extension makes it easy to embed Shiny for Python applications in your Quarto documents. This makes it possible to add interactivity to your documents with just Python code. For example, you can include an interactive Shiny application like this, directly inside your Quarto document.
In ca... | {
"lastmod": "2023-07-05T19:35:15.223Z",
"loc": "https://quarto.org/docs/blog/posts/2022-10-25-shinylive-extension/index.html",
"source": "https://quarto.org/docs/blog/posts/2022-10-25-shinylive-extension/index.html"
} |
We are happy to announce that Quarto 1.3 has been released. You can grab the current release from https://quarto.org/docs/download/.
If you are ever wondering which version of Quarto you are using, a quick way to check on the command line is:
Terminal
quarto --version
We’ve previously blogged about some of the feat... | {
"lastmod": "2023-07-05T19:35:15.247Z",
"loc": "https://quarto.org/docs/blog/posts/2023-04-26-1.3-release/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-04-26-1.3-release/index.html"
} |
Quarto 1.3 Feature
This post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.
Code blocks and executable code cells in Quarto may now include line-based annotations. Line-based annotations provide a way to attach explanation to ... | {
"lastmod": "2023-07-05T19:35:15.223Z",
"loc": "https://quarto.org/docs/blog/posts/2023-03-13-code-annotation/index.html",
"source": "https://quarto.org/docs/blog/posts/2023-03-13-code-annotation/index.html"
} |
Overview
Shortcodes are special markdown directives that generate various types of content. Quarto shortcodes are similar in form and function to Hugo shortcodes and WordPress shortcodes.
For example, the following shortcode prints the title from document metadata:
{{< meta title >}}
Quarto supports several shortcodes ... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/shortcodes.html",
"source": "https://quarto.org/docs/extensions/shortcodes.html"
} |
Overview
Revealjs plugins enable you to extend the capabilities of HTML presentations created with Revealjs. The Reveal Plugin API is very rich, and many of the built-in capabilities of Quarto Revealjs presentations are implemented as plugins, including Menu, Chalkboard, and PDF Export.
Here are some examples of Reveal... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/revealjs.html",
"source": "https://quarto.org/docs/extensions/revealjs.html"
} |
Extensions are a powerful way to modify and extend the behavior of Quarto. Below is a listing of available extensions (please let us know if you have an extension you’d like to see added to the list).
See the articles on Creating Extensions to learn how to develop your own extensions.
Shortcode/Filter
Jou... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/listing-journals.html",
"source": "https://quarto.org/docs/extensions/listing-journals.html"
} |
Overview
Starter templates provide a straightforward way for users to get started with new Quarto projects by providing example content and options. You might use starter templates to:
Create a working initial document for Journal Articles or Custom Formats.
Provide the initial content for a custom Project Type.
Scaff... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/starter-templates.html",
"source": "https://quarto.org/docs/extensions/starter-templates.html"
} |
Extensions are a powerful way to modify and extend the behavior of Quarto. Below is a listing of available extensions (please let us know if you have an extension you’d like to see added to the list).
See the articles on Creating Extensions to learn how to develop your own extensions.
Shortcode/Filter
Jou... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/listing-revealjs.html",
"source": "https://quarto.org/docs/extensions/listing-revealjs.html"
} |
Overview
If you are rendering existing Jupyter notebooks that were not created with Quarto in mind, you may wish to do some pre-processing on the notebook prior to its conversion to markdown. This can be accomplished by specifying one or more ipynb-filters. These filters are passed the JSON representation of the notebo... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/nbfilter.html",
"source": "https://quarto.org/docs/extensions/nbfilter.html"
} |
Overview
This article provides documentation on the standard APIs available when implementing Lua filters and shortcodes. There are three major sets of APIs available:
Lua Base API—Base functions provided for string handling, pattern matching, table manipulation, and file input and output.
Pandoc Lua API—Core API prov... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/lua-api.html",
"source": "https://quarto.org/docs/extensions/lua-api.html"
} |
Overview
Custom project types provide the ability to tailor projects for a particular purpose. This could be used to create a project type that implements an organization-level standard for creating documentation or conducting analyses.
For example, if you created a project type extension called lexdocs, it could be us... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/project-types.html",
"source": "https://quarto.org/docs/extensions/project-types.html"
} |
Overview
Quarto format extensions enable you to add new formats to the built-in formats (e.g. html, pdf, docx) already available. Custom formats can provide default document options, style-sheets, header, footer, or logo elements, and even bundle other extensions like filters and shortcodes. They are a great way to pro... | {
"lastmod": "2023-07-05T19:35:15.275Z",
"loc": "https://quarto.org/docs/extensions/formats.html",
"source": "https://quarto.org/docs/extensions/formats.html"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.