Skip to content

Commit 65b226c

Browse files
Update reference pages (prerelease) (#1960)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent fb23f2c commit 65b226c

5 files changed

Lines changed: 89 additions & 49 deletions

File tree

docs/cli/cli-info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "1.9.27",
2+
"version": "1.9.35",
33
"commands": [
44
{
55
"name": "render",

docs/reference/formats/epub.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,6 @@
119119
"name": "contributor",
120120
"description": "Contributors to this publication."
121121
},
122-
{
123-
"name": "subject",
124-
"description": "The subject of the publication."
125-
},
126122
{
127123
"name": "type",
128124
"description": "Text describing the specialized type of this publication.\n\nAn informative registry of specialized EPUB Publication \ntypes for use with this element is maintained in the \n[TypesRegistry](https://www.w3.org/publishing/epub32/epub-packages.html#bib-typesregistry), \nbut Authors may use any text string as a value.\n"
@@ -414,6 +410,10 @@
414410
"name": "metadata",
415411
"title": "Metadata",
416412
"options": [
413+
{
414+
"name": "subject",
415+
"description": "The document subject"
416+
},
417417
{
418418
"name": "date-meta",
419419
"description": "Sets the date metadata for the document"

docs/reference/formats/markdown/hugo.json

Lines changed: 58 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
"name": "date",
1212
"description": "Document date"
1313
},
14+
{
15+
"name": "date-format",
16+
"description": "Date format for the document"
17+
},
1418
{
1519
"name": "author",
1620
"description": "Author or authors of the document"
@@ -25,6 +29,10 @@
2529
"name": "options",
2630
"title": "Format Options",
2731
"options": [
32+
{
33+
"name": "brand",
34+
"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, or an object with light and dark brand paths or definitions.\n"
35+
},
2836
{
2937
"name": "html-math-method",
3038
"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"
@@ -41,13 +49,13 @@
4149
"name": "markdown-headings",
4250
"description": "Specify whether to use `atx` (`#`-prefixed) or\n`setext` (underlined) headings for level 1 and 2\nheadings (`atx` or `setext`).\n"
4351
},
44-
{
45-
"name": "keep-yaml",
46-
"description": "Preserve the original YAML front matter in rendered markdown"
47-
},
4852
{
4953
"name": "quarto-required",
5054
"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"
55+
},
56+
{
57+
"name": "preview-mode",
58+
"description": "The mode to use when previewing this document. To disable any special\npreviewing features, pass `raw` as the preview-mode.\n"
5159
}
5260
]
5361
},
@@ -57,7 +65,7 @@
5765
"options": [
5866
{
5967
"name": "toc",
60-
"description": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document. This option has no effect\nif `standalone` is `false`.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n"
68+
"description": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n"
6169
},
6270
{
6371
"name": "toc-depth",
@@ -73,28 +81,34 @@
7381
"name": "number-sections",
7482
"description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n"
7583
},
76-
{
77-
"name": "number-offset",
78-
"description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n"
79-
},
8084
{
8185
"name": "shift-heading-level-by",
8286
"description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n"
8387
}
8488
]
8589
},
90+
{
91+
"name": "code",
92+
"title": "Code",
93+
"options": [
94+
{
95+
"name": "code-annotations",
96+
"description": "The style to use when displaying code annotations. Set this value\nto false to hide code annotations.\n"
97+
}
98+
]
99+
},
86100
{
87101
"name": "execute",
88102
"title": "Execution",
89103
"description": "Execution options should be specified within the `execute` key. For example:\n\n```yaml\nexecute:\n echo: false\n warning: false\n```\n",
90104
"options": [
91105
{
92106
"name": "eval",
93-
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
107+
"description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative numbers to selectively include or exclude expressions \n (explicit inclusion/exclusion of expressions is available only when using the knitr engine)\n"
94108
},
95109
{
96110
"name": "echo",
97-
"description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: in addition to echoing, include the cell delimiter as part of the output.\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
111+
"description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: in addition to echoing, include the cell delimiter as part of the output.\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n"
98112
},
99113
{
100114
"name": "output",
@@ -128,34 +142,30 @@
128142
"options": [
129143
{
130144
"name": "fig-width",
131-
"description": "Default width for figures generated by Matplotlib or R graphics"
145+
"description": "Default width for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
132146
},
133147
{
134148
"name": "fig-height",
135-
"description": "Default height for figures generated by Matplotlib or R graphics"
149+
"description": "Default height for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
136150
},
137151
{
138152
"name": "fig-format",
139153
"description": "Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)"
140154
},
141155
{
142156
"name": "fig-dpi",
143-
"description": "Default DPI for figures generated by Matplotlib or R graphics"
157+
"description": "Default DPI for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n"
144158
},
145159
{
146160
"name": "fig-asp",
147-
"description": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified, \nthe height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`.\n\nThe `fig-asp` option is only available within the knitr engine.\n"
161+
"description": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified,\nthe height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`.\n\nThe `fig-asp` option is only available within the knitr engine.\n"
148162
}
149163
]
150164
},
151165
{
152166
"name": "tables",
153167
"title": "Tables",
154168
"options": [
155-
{
156-
"name": "tbl-colwidths",
157-
"description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n"
158-
},
159169
{
160170
"name": "df-print",
161171
"description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n"
@@ -194,6 +204,16 @@
194204
}
195205
]
196206
},
207+
{
208+
"name": "crossref",
209+
"title": "Cross-References",
210+
"options": [
211+
{
212+
"name": "crossref",
213+
"description": "Configuration for cross-reference labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details."
214+
}
215+
]
216+
},
197217
{
198218
"name": "citation",
199219
"title": "Citation",
@@ -228,19 +248,19 @@
228248
"options": [
229249
{
230250
"name": "include-before-body",
231-
"description": "Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command \nin LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
251+
"description": "Include contents at the beginning of the document body\n(e.g. after the `<body>` tag in HTML, or the `\\begin{document}` command\nin LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
232252
},
233253
{
234254
"name": "include-after-body",
235-
"description": "Include contents at the end of the document body (before\nthe `</body>` tag in HTML, or the `\\end{document}` command in LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
255+
"description": "Include content at the end of the document body immediately after the markdown content. While it will be included before the closing `</body>` tag in HTML and the `\\end{document}` command in LaTeX, this option refers to the end of the markdown content.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
236256
},
237257
{
238258
"name": "include-in-header",
239-
"description": "Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML \ndocuments.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
259+
"description": "Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML\ndocuments.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n"
240260
},
241261
{
242262
"name": "metadata-files",
243-
"description": "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside \nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
263+
"description": "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside\nthe document, or by using `-M`, overwrite values specified with\nthis option.\n"
244264
}
245265
]
246266
},
@@ -268,17 +288,13 @@
268288
"name": "template-partials",
269289
"description": "Include the specified files as partials accessible to the template for the generated content.\n"
270290
},
271-
{
272-
"name": "standalone",
273-
"description": "Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n"
274-
},
275291
{
276292
"name": "filters",
277293
"description": "Specify executables or Lua scripts to be used as a filter transforming\nthe pandoc AST after the input is parsed and before the output is written.\n"
278294
},
279295
{
280296
"name": "shortcodes",
281-
"description": "Speicfy Lua scripts that implement shortcode handlers\n"
297+
"description": "Specify Lua scripts that implement shortcode handlers\n"
282298
},
283299
{
284300
"name": "keep-md",
@@ -292,13 +308,21 @@
292308
"name": "ipynb-filters",
293309
"description": "Filters to pre-process ipynb files before rendering to markdown"
294310
},
311+
{
312+
"name": "ipynb-shell-interactivity",
313+
"description": "Specify which nodes should be run interactively (displaying output from expressions)\n"
314+
},
315+
{
316+
"name": "plotly-connected",
317+
"description": "If true, use the \"notebook_connected\" plotly renderer, which downloads\nits dependencies from a CDN and requires an internet connection to view.\n"
318+
},
295319
{
296320
"name": "extract-media",
297321
"description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n"
298322
},
299323
{
300324
"name": "resource-path",
301-
"description": "List of paths to search for images and other resources. The paths should\nbe separated by : on Linux, UNIX, and macOS systems, and by ; on Windows.\n"
325+
"description": "List of paths to search for images and other resources.\n"
302326
},
303327
{
304328
"name": "default-image-extension",
@@ -311,6 +335,10 @@
311335
{
312336
"name": "dpi",
313337
"description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n"
338+
},
339+
{
340+
"name": "html-table-processing",
341+
"description": "If `none`, do not process tables in HTML input."
314342
}
315343
]
316344
},
@@ -324,7 +352,7 @@
324352
},
325353
{
326354
"name": "columns",
327-
"description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n"
355+
"description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n"
328356
},
329357
{
330358
"name": "tab-stop",

docs/reference/formats/presentations/revealjs.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -433,10 +433,6 @@
433433
"name": "height",
434434
"description": "The \"normal\" height of the presentation, aspect ratio will\nbe preserved when the presentation is scaled to fit different\nresolutions. Can be specified using percentage units.\n"
435435
},
436-
{
437-
"name": "margin",
438-
"description": "For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).\n\nFor `typst`, a dictionary with the fields defined in the Typst documentation:\n`x`, `y`, `top`, `bottom`, `left`, `right` (margins are specified in `cm` units,\ne.g. `5cm`).\n"
439-
},
440436
{
441437
"name": "min-scale",
442438
"description": "Bounds for smallest possible scale to apply to content"
@@ -502,6 +498,10 @@
502498
{
503499
"name": "margin-bottom",
504500
"description": "For HTML output, sets the `margin-bottom` property on the Body element.\n\nFor LaTeX output, sets the bottom margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the bottom margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the bottom page margin.\n"
501+
},
502+
{
503+
"name": "margin",
504+
"description": "For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).\n\nFor `typst`, a dictionary specifying page margins. Use `x` and `y` for symmetric\nhorizontal/vertical margins, or `top`, `bottom`, `left`, `right` for\nindividual sides. Values should include units (e.g. `1.5in`, `2cm`).\n"
505505
}
506506
]
507507
},

0 commit comments

Comments
 (0)