Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/reference/formats/asciidoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
Expand Down Expand Up @@ -186,11 +190,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/context.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "pdf-engine",
"description": "Use the specified engine when producing PDF output. If the engine is not\nin your PATH, the full path of the engine may be specified here. If this\noption is not specified, Quarto uses the following defaults\ndepending on the output format in use:\n\n- `latex`: `xelatex` (other options: `pdflatex`, `lualatex`,\n `tectonic`, `latexmk`)\n- `context`: `context`\n- `html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`, `pagedjs-cli`;\n see [print-css.rocks](https://print-css.rocks) for a good\n introduction to PDF generation from HTML/CSS.)\n- `ms`: `pdfroff`\n- `typst`: `typst`\n"
Expand Down Expand Up @@ -288,11 +292,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/dashboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "theme",
"description": "Theme name, theme scss file, or a mix of both."
Expand Down Expand Up @@ -346,11 +350,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
},
{
"name": "crossrefs-hover",
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/docbook.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "identifier-prefix",
"description": "Specify a prefix to be added to all identifiers and internal links in HTML and\nDocBook output, and to footnote numbers in Markdown and Haddock output. \nThis is useful for preventing duplicate identifiers when generating fragments\nto be included in other pages.\n"
Expand Down Expand Up @@ -176,11 +180,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
10 changes: 7 additions & 3 deletions docs/reference/formats/docx.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@
"name": "reference-doc",
"description": "Use the specified file as a style reference in producing a docx, \npptx, or odt file.\n"
},
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
Expand Down Expand Up @@ -93,7 +97,7 @@
"options": [
{
"name": "page-width",
"description": "Target page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt.\n"
"description": "Target body page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt (8.5 inches with 1 inch for each margins).\n"
},
{
"name": "grid",
Expand Down Expand Up @@ -238,11 +242,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/epub.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "css",
"description": "One or more CSS style sheets."
Expand Down Expand Up @@ -350,11 +354,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/fb2.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
Expand Down Expand Up @@ -182,11 +186,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/haddock.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "identifier-prefix",
"description": "Specify a prefix to be added to all identifiers and internal links in HTML and\nDocBook output, and to footnote numbers in Markdown and Haddock output. \nThis is useful for preventing duplicate identifiers when generating fragments\nto be included in other pages.\n"
Expand Down Expand Up @@ -186,11 +190,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/html.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "theme",
"description": "Theme name, theme scss file, or a mix of both."
Expand Down Expand Up @@ -520,11 +524,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
},
{
"name": "crossrefs-hover",
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/icml.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
Expand Down Expand Up @@ -182,11 +186,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/ipynb.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "markdown-headings",
"description": "Specify whether to use `atx` (`#`-prefixed) or\n`setext` (underlined) headings for level 1 and 2\nheadings (`atx` or `setext`).\n"
Expand Down Expand Up @@ -190,11 +194,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/jats.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "quarto-required",
"description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n"
Expand Down Expand Up @@ -210,11 +214,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/man.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "section",
"description": "The section number in man pages."
Expand Down Expand Up @@ -186,11 +190,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/markdown/commonmark.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "identifier-prefix",
"description": "Specify a prefix to be added to all identifiers and internal links in HTML and\nDocBook output, and to footnote numbers in Markdown and Haddock output. \nThis is useful for preventing duplicate identifiers when generating fragments\nto be included in other pages.\n"
Expand Down Expand Up @@ -204,11 +208,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
8 changes: 6 additions & 2 deletions docs/reference/formats/markdown/gfm.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
"name": "options",
"title": "Format Options",
"options": [
{
"name": "brand",
"description": "Branding information to use for this document. If a string, the path to a brand file.\nIf false, don't use branding on this document. If an object, an inline brand\ndefinition.\n"
},
{
"name": "html-math-method",
"description": "Method use to render math in HTML output (`plain`, `webtex`, `gladtex`, `mathml`, `mathjax`, `katex`).\n\nSee the Pandoc documentation on [Math Rendering in HTML](https://pandoc.org/MANUAL.html#math-rendering-in-html)\nfor additional details.\n"
Expand Down Expand Up @@ -212,11 +216,11 @@
},
{
"name": "crossref",
"title": "Crossrefs",
"title": "Cross-References",
"options": [
{
"name": "crossref",
"description": "Configuration for crossref labels and prefixes."
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
}
]
},
Expand Down
Loading