From ff6ebd64d2bd190fec8625940c7b77df6911bec7 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 9 Mar 2026 21:36:21 +0000 Subject: [PATCH] Update reference pages for prerelease v1.9.31 --- docs/cli/cli-info.json | 2 +- docs/reference/formats/epub.json | 8 +- docs/reference/formats/markdown/hugo.json | 352 +----------------- .../formats/presentations/revealjs.json | 8 +- docs/reference/formats/typst.json | 32 +- 5 files changed, 32 insertions(+), 370 deletions(-) diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json index 2d0dab6b11..fc4a5cdca1 100644 --- a/docs/cli/cli-info.json +++ b/docs/cli/cli-info.json @@ -1,5 +1,5 @@ { - "version": "1.9.27", + "version": "1.9.31", "commands": [ { "name": "render", diff --git a/docs/reference/formats/epub.json b/docs/reference/formats/epub.json index b6d77b85bc..0c32b5b5d7 100644 --- a/docs/reference/formats/epub.json +++ b/docs/reference/formats/epub.json @@ -119,10 +119,6 @@ "name": "contributor", "description": "Contributors to this publication." }, - { - "name": "subject", - "description": "The subject of the publication." - }, { "name": "type", "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 @@ "name": "metadata", "title": "Metadata", "options": [ + { + "name": "subject", + "description": "The document subject" + }, { "name": "date-meta", "description": "Sets the date metadata for the document" diff --git a/docs/reference/formats/markdown/hugo.json b/docs/reference/formats/markdown/hugo.json index c0094e61e3..0637a088a0 100644 --- a/docs/reference/formats/markdown/hugo.json +++ b/docs/reference/formats/markdown/hugo.json @@ -1,351 +1 @@ -[ - { - "name": "attributes", - "title": "Title & Author", - "options": [ - { - "name": "title", - "description": "Document title" - }, - { - "name": "date", - "description": "Document date" - }, - { - "name": "author", - "description": "Author or authors of the document" - }, - { - "name": "order", - "description": "Order for document when included in a website automatic sidebar menu." - } - ] - }, - { - "name": "options", - "title": "Format Options", - "options": [ - { - "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" - }, - { - "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" - }, - { - "name": "variant", - "description": "Enable and disable extensions for markdown output (e.g. \"+emoji\")\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" - }, - { - "name": "keep-yaml", - "description": "Preserve the original YAML front matter in rendered markdown" - }, - { - "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" - } - ] - }, - { - "name": "toc", - "title": "Table of Contents", - "options": [ - { - "name": "toc", - "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" - }, - { - "name": "toc-depth", - "description": "Specify the number of section levels to include in the table of contents.\nThe default is 3\n" - } - ] - }, - { - "name": "numbering", - "title": "Numbering", - "options": [ - { - "name": "number-sections", - "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" - }, - { - "name": "number-offset", - "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" - }, - { - "name": "shift-heading-level-by", - "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" - } - ] - }, - { - "name": "execute", - "title": "Execution", - "description": "Execution options should be specified within the `execute` key. For example:\n\n```yaml\nexecute:\n echo: false\n warning: false\n```\n", - "options": [ - { - "name": "eval", - "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" - }, - { - "name": "echo", - "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" - }, - { - "name": "output", - "description": "Include the results of executing the code in the output. Possible values:\n\n- `true`: Include results.\n- `false`: Do not include results.\n- `asis`: Treat output as raw markdown with no enclosing containers.\n" - }, - { - "name": "warning", - "description": "Include warnings in rendered output." - }, - { - "name": "error", - "description": "Include errors in the output (note that this implies that errors executing code\nwill not halt processing of the document).\n" - }, - { - "name": "include", - "description": "Catch all for preventing any output (code or results) from being included in output.\n" - }, - { - "name": "cache", - "description": "Cache results of computations (using the [knitr cache](https://yihui.org/knitr/demo/cache/) \nfor R documents, and [Jupyter Cache](https://jupyter-cache.readthedocs.io/en/latest/) \nfor Jupyter documents).\n\nNote that cache invalidation is triggered by changes in chunk source code \n(or other cache attributes you've defined). \n\n- `true`: Cache results\n- `false`: Do not cache results\n- `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.\n" - }, - { - "name": "freeze", - "description": "Control the re-use of previous computational output when rendering.\n\n- `true`: Never recompute previously generated computational output during a global project render\n- `false` (default): Recompute previously generated computational output\n- `auto`: Re-compute previously generated computational output only in case their source file changes\n" - } - ] - }, - { - "name": "figures", - "title": "Figures", - "options": [ - { - "name": "fig-width", - "description": "Default width for figures generated by Matplotlib or R graphics" - }, - { - "name": "fig-height", - "description": "Default height for figures generated by Matplotlib or R graphics" - }, - { - "name": "fig-format", - "description": "Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)" - }, - { - "name": "fig-dpi", - "description": "Default DPI for figures generated by Matplotlib or R graphics" - }, - { - "name": "fig-asp", - "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" - } - ] - }, - { - "name": "tables", - "title": "Tables", - "options": [ - { - "name": "tbl-colwidths", - "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" - }, - { - "name": "df-print", - "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" - } - ] - }, - { - "name": "references", - "title": "References", - "options": [ - { - "name": "bibliography", - "description": "Document bibliography (BibTeX or CSL). May be a single file or a list of files\n" - }, - { - "name": "csl", - "description": "Citation Style Language file to use for formatting references." - }, - { - "name": "citeproc", - "description": "Turn on built-in citation processing. To use this feature, you will need\nto have a document containing citations and a source of bibliographic data: \neither an external bibliography file or a list of `references` in the \ndocument's YAML metadata. You can optionally also include a `csl` \ncitation style file.\n" - }, - { - "name": "citation-abbreviations", - "description": "JSON file containing abbreviations of journals that should be\nused in formatted bibliographies when `form=\"short\"` is\nspecified. The format of the file can be illustrated with an\nexample:\n\n```json\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n```\n" - } - ] - }, - { - "name": "footnotes", - "title": "Footnotes", - "options": [ - { - "name": "reference-location", - "description": "Specify location for footnotes. Also controls the location of references, if `reference-links` is set.\n\n- `block`: Place at end of current top-level block\n- `section`: Place at end of current section\n- `margin`: Place at the margin\n- `document`: Place at end of document\n" - } - ] - }, - { - "name": "citation", - "title": "Citation", - "options": [ - { - "name": "citation", - "description": "Citation information for the document itself specified as [CSL](https://docs.citationstyles.org/en/stable/specification.html) \nYAML in the document front matter.\n\nFor more on supported options, see [Citation Metadata](https://quarto.org/docs/reference/metadata/citation.html).\n" - } - ] - }, - { - "name": "language", - "title": "Language", - "options": [ - { - "name": "lang", - "description": "Identifies the main language of the document using IETF language tags \n(following the [BCP 47](https://www.rfc-editor.org/info/bcp47) standard), \nsuch as `en` or `en-GB`. The [Language subtag lookup](https://r12a.github.io/app-subtags/) \ntool can look up or verify these tags. \n\nThis affects most formats, and controls hyphenation \nin PDF output when using LaTeX (through [`babel`](https://ctan.org/pkg/babel) \nand [`polyglossia`](https://ctan.org/pkg/polyglossia)) or ConTeXt.\n" - }, - { - "name": "language", - "description": "YAML file containing custom language translations" - }, - { - "name": "dir", - "description": "The base script direction for the document (`rtl` or `ltr`).\n\nFor bidirectional documents, native pandoc `span`s and\n`div`s with the `dir` attribute can\nbe used to override the base direction in some output\nformats. This may not always be necessary if the final\nrenderer (e.g. the browser, when generating HTML) supports\nthe [Unicode Bidirectional Algorithm].\n\nWhen using LaTeX for bidirectional documents, only the\n`xelatex` engine is fully supported (use\n`--pdf-engine=xelatex`).\n" - } - ] - }, - { - "name": "includes", - "title": "Includes", - "options": [ - { - "name": "include-before-body", - "description": "Include contents at the beginning of the document body\n(e.g. after the `` 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" - }, - { - "name": "include-after-body", - "description": "Include contents at the end of the document body (before\nthe `` 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" - }, - { - "name": "include-in-header", - "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" - }, - { - "name": "metadata-files", - "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" - } - ] - }, - { - "name": "render", - "title": "Rendering", - "options": [ - { - "name": "from", - "description": "Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n" - }, - { - "name": "output-file", - "description": "Output file to write to" - }, - { - "name": "output-ext", - "description": "Extension to use for generated output file\n" - }, - { - "name": "template", - "description": "Use the specified file as a custom template for the generated document.\n" - }, - { - "name": "template-partials", - "description": "Include the specified files as partials accessible to the template for the generated content.\n" - }, - { - "name": "standalone", - "description": "Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n" - }, - { - "name": "filters", - "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" - }, - { - "name": "shortcodes", - "description": "Speicfy Lua scripts that implement shortcode handlers\n" - }, - { - "name": "keep-md", - "description": "Keep the markdown file generated by executing code" - }, - { - "name": "keep-ipynb", - "description": "Keep the notebook file generated from executing code." - }, - { - "name": "ipynb-filters", - "description": "Filters to pre-process ipynb files before rendering to markdown" - }, - { - "name": "extract-media", - "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" - }, - { - "name": "resource-path", - "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" - }, - { - "name": "default-image-extension", - "description": "Specify a default extension to use when image paths/URLs have no\nextension. This allows you to use the same source for formats that\nrequire different kinds of images. Currently this option only affects\nthe Markdown and LaTeX readers.\n" - }, - { - "name": "abbreviations", - "description": "Specifies a custom abbreviations file, with abbreviations one to a line.\nThis list is used when reading Markdown input: strings found in this list\nwill be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain\nspaces.\n" - }, - { - "name": "dpi", - "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" - } - ] - }, - { - "name": "text", - "title": "Text Output", - "options": [ - { - "name": "wrap", - "description": "Determine how text is wrapped in the output (the source code, not the rendered\nversion). \n\n- `auto` (default): Pandoc will attempt to wrap lines to the column width specified by `columns` (default 72). \n- `none`: Pandoc will not wrap lines at all. \n- `preserve`: Pandoc will attempt to preserve the wrapping from the source\n document. Where there are nonsemantic newlines in the source, there will be\n nonsemantic newlines in the output as well.\n" - }, - { - "name": "columns", - "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" - }, - { - "name": "tab-stop", - "description": "Specify the number of spaces per tab (default is 4). Note that tabs\nwithin normal textual input are always converted to spaces. Tabs \nwithin code are also converted, however this can be disabled with\n`preserve-tabs: false`.\n" - }, - { - "name": "preserve-tabs", - "description": "Preserve tabs within code instead of converting them to spaces.\n(By default, pandoc converts tabs to spaces before parsing its input.) \nNote that this will only affect tabs in literal code spans and code blocks. \nTabs in regular text are always treated as spaces.\n" - }, - { - "name": "eol", - "description": "Manually specify line endings: \n\n- `crlf`: Use Windows line endings\n- `lf`: Use macOS/Linux/UNIX line endings\n- `native` (default): Use line endings appropriate to the OS on which pandoc is being run).\n" - }, - { - "name": "strip-comments", - "description": "Strip out HTML comments in the Markdown source,\nrather than passing them on to Markdown, Textile or HTML\noutput as raw HTML. This does not apply to HTML comments\ninside raw HTML blocks when the `markdown_in_html_blocks`\nextension is not set.\n" - }, - { - "name": "ascii", - "description": "Use only ASCII characters in output. Currently supported for XML\nand HTML formats (which use entities instead of UTF-8 when this\noption is selected), CommonMark, gfm, and Markdown (which use\nentities), roff ms (which use hexadecimal escapes), and to a\nlimited degree LaTeX (which uses standard commands for accented\ncharacters when possible). roff man output uses ASCII by default.\n" - } - ] - } -] \ No newline at end of file +[] \ No newline at end of file diff --git a/docs/reference/formats/presentations/revealjs.json b/docs/reference/formats/presentations/revealjs.json index 13fe7939d1..45e6d68a1e 100644 --- a/docs/reference/formats/presentations/revealjs.json +++ b/docs/reference/formats/presentations/revealjs.json @@ -433,10 +433,6 @@ "name": "height", "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" }, - { - "name": "margin", - "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" - }, { "name": "min-scale", "description": "Bounds for smallest possible scale to apply to content" @@ -502,6 +498,10 @@ { "name": "margin-bottom", "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" + }, + { + "name": "margin", + "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" } ] }, diff --git a/docs/reference/formats/typst.json b/docs/reference/formats/typst.json index 2e3f2544e6..0141ba972a 100644 --- a/docs/reference/formats/typst.json +++ b/docs/reference/formats/typst.json @@ -33,6 +33,24 @@ } ] }, + { + "name": "typst", + "title": "Typst", + "options": [ + { + "name": "logo", + "description": "The logo image." + }, + { + "name": "margin-geometry", + "description": "Fine-grained control over marginalia package geometry. Most users should\nuse `margin` and `grid` options instead; these values are computed automatically.\n\nUser-specified values override the computed defaults.\n" + }, + { + "name": "theorem-appearance", + "description": "Controls how theorems, lemmas, definitions, etc. are rendered:\n\n- `simple`: Plain text with bold title and italic body (default)\n- `fancy`: Colored boxes using brand colors\n- `clouds`: Rounded colored background boxes\n- `rainbow`: Colored left border with colored title\n" + } + ] + }, { "name": "options", "title": "Format Options", @@ -95,16 +113,6 @@ } ] }, - { - "name": "reveal-layout", - "title": "Slide Layout", - "options": [ - { - "name": "margin", - "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" - } - ] - }, { "name": "fonts", "title": "Fonts", @@ -180,6 +188,10 @@ { "name": "grid", "description": "Properties of the grid system used to layout Quarto HTML and Typst pages." + }, + { + "name": "margin", + "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" } ] },