html.json

[
  {
    "name": "attributes",
    "title": "Title & Author",
    "options": [
      {
        "name": "title",
        "description": "Document title"
      },
      {
        "name": "subtitle",
        "description": "Identifies the subtitle of the document."
      },
      {
        "name": "date",
        "description": "Document date"
      },
      {
        "name": "date-modified",
        "description": "Document date modified"
      },
      {
        "name": "author",
        "description": "Author or authors of the document"
      },
      {
        "name": "abstract",
        "description": "Summary of document"
      },
      {
        "name": "abstract-title",
        "description": "Title used to label document abstract"
      },
      {
        "name": "doi",
        "description": "Displays the document Digital Object Identifier in the header."
      },
      {
        "name": "order",
        "description": "Order for document when included in a website automatic sidebar menu."
      }
    ]
  },
  {
    "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."
      },
      {
        "name": "body-classes",
        "description": "Classes to apply to the body of the document.\n"
      },
      {
        "name": "minimal",
        "description": "Disables the built in html features like theming, anchor sections, code block behavior, and more."
      },
      {
        "name": "css",
        "description": "One or more CSS style sheets."
      },
      {
        "name": "anchor-sections",
        "description": "Enables hover over a section title to see an anchor link."
      },
      {
        "name": "tabsets",
        "description": "Enables tabsets to present content."
      },
      {
        "name": "smooth-scroll",
        "description": "Enables smooth scrolling within the page."
      },
      {
        "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": "section-divs",
        "description": "Wrap sections in `<section>` tags and attach identifiers to the enclosing `<section>`\nrather than the heading itself.\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": "email-obfuscation",
        "description": "Specify a method for obfuscating `mailto:` links in HTML documents.\n\n- `javascript`: Obfuscate links using JavaScript.\n- `references`: Obfuscate links by printing their letters as decimal or hexadecimal character references.\n- `none` (default): Do not obfuscate links.\n"
      },
      {
        "name": "html-q-tags",
        "description": "Use `<q>` tags for quotes in HTML."
      },
      {
        "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.\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": "toc-location",
        "description": "Location for table of contents:\n\n- `body`: Show the Table of Contents in the center body of the document. \n- `left`: Show the Table of Contents in left margin of the document.\n- `right`(default): Show the Table of Contents in right margin of the document.\n- `left-body`: Show two Tables of Contents in both the center body and the left margin of the document.\n- `right-body`: Show two Tables of Contents in both the center body and the right margin of the document.\n"
      },
      {
        "name": "toc-title",
        "description": "The title used for the table of contents."
      },
      {
        "name": "toc-expand",
        "description": "Specifies the depth of items in the table of contents that should be displayed as expanded in HTML output. Use `true` to expand all or `false` to collapse all.\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-depth",
        "description": "By default, all headings in your document create a \nnumbered section. You customize numbering depth using \nthe `number-depth` option. \n\nFor example, to only number sections immediately below \nthe chapter level, use this:\n\n```yaml  \nnumber-depth: 1\n```\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": "fonts",
    "title": "Fonts",
    "options": [
      {
        "name": "mainfont",
        "description": "For HTML output, sets the CSS `font-family` on the HTML element.\n\nFor LaTeX output, the main font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the main font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
      },
      {
        "name": "monofont",
        "description": "For HTML output, sets the CSS font-family property on code elements.\n\nFor PowerPoint output, sets the font used for code.\n\nFor LaTeX output, the monospace font family for use with `xelatex` or \n`lualatex`: take the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package.  \n\nFor ConTeXt output, the monspace font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n"
      },
      {
        "name": "fontsize",
        "description": "For HTML output, sets the base CSS `font-size` property.\n\nFor LaTeX and ConTeXt output, sets the font size for the document body text.\n"
      },
      {
        "name": "linestretch",
        "description": "For HTML output sets the CSS `line-height` property on the html \nelement, which is preferred to be unitless.\n\nFor LaTeX output, adjusts line spacing using the \n[setspace](https://ctan.org/pkg/setspace) package, e.g. 1.25, 1.5.\n"
      }
    ]
  },
  {
    "name": "colors",
    "title": "Colors",
    "options": [
      {
        "name": "fontcolor",
        "description": "Sets the CSS `color` property."
      },
      {
        "name": "linkcolor",
        "description": "For HTML output, sets the CSS `color` property on all links.\n\nFor LaTeX output, The color used for internal links using color options\nallowed by [`xcolor`](https://ctan.org/pkg/xcolor), \nincluding the `dvipsnames`, `svgnames`, and\n`x11names` lists.\n\nFor ConTeXt output, sets the color for both external links and links within the document.\n"
      },
      {
        "name": "monobackgroundcolor",
        "description": "Sets the CSS `background-color` property on code elements and adds extra padding."
      },
      {
        "name": "backgroundcolor",
        "description": "Sets the CSS `background-color` property on the html element.\n"
      }
    ]
  },
  {
    "name": "layout",
    "title": "Layout",
    "options": [
      {
        "name": "cap-location",
        "description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)"
      },
      {
        "name": "fig-cap-location",
        "description": "Where to place figure captions (`top`, `bottom`, or `margin`)"
      },
      {
        "name": "tbl-cap-location",
        "description": "Where to place table captions (`top`, `bottom`, or `margin`)"
      },
      {
        "name": "classoption",
        "description": "For LaTeX/PDF output, the options set for the document\nclass.\n\nFor HTML output using KaTeX, you can render display\nmath equations flush left using `classoption: fleqn`\n"
      },
      {
        "name": "page-layout",
        "description": "The page layout to use for this document (`article`, `full`, or `custom`)"
      },
      {
        "name": "grid",
        "description": "Properties of the grid system used to layout Quarto HTML pages."
      },
      {
        "name": "appendix-style",
        "description": "The layout of the appendix for this document (`none`, `plain`, or `default`).\n\nTo completely disable any styling of the appendix, choose the appendix style `none`. For minimal styling, choose `plain.`\n"
      },
      {
        "name": "appendix-cite-as",
        "description": "Controls the formats which are provided in the citation section of the appendix.\n\nUse `false` to disable the display of the 'cite as' appendix. Pass one or more of `display` or `bibtex` to enable that\nformat in 'cite as' appendix.\n"
      },
      {
        "name": "title-block-style",
        "description": "The layout of the title block for this document (`none`, `plain`, or `default`).\n\nTo completely disable any styling of the title block, choose the style `none`. For minimal styling, choose `plain.`\n"
      },
      {
        "name": "title-block-banner",
        "description": "Applies a banner style treatment for the title block. You may specify one of the following values:\n\n`true`\n: Will enable the banner style display and automatically select a background color based upon the theme.\n\n`<css color value>`\n: If you provide a CSS color value, the banner will be enabled and the background color set to the provided CSS color.\n\n`<path>`\n: If you provide the path to a file, the banner will be enabled and the background image will be set to the file path.\n\nSee `title-block-banner-color` if you'd like to control the color of the title block banner text.\n"
      },
      {
        "name": "title-block-banner-color",
        "description": "Sets the color of text elements in a banner style title block. Use one of the following values:\n\n`body` | `body-bg`\n: Will set the text color to the body text color or body background color, respectively.\n\n`<css color value>`\n: If you provide a CSS color value, the text color will be set to the provided CSS color.\n"
      },
      {
        "name": "title-block-categories",
        "description": "Enables or disables the display of categories in the title block."
      },
      {
        "name": "max-width",
        "description": "Adds a css `max-width` to the body Element."
      },
      {
        "name": "margin-left",
        "description": "For HTML output, sets the `margin-left` property on the Body element.\n\nFor LaTeX output, sets the left margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the left margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the left page margin.\n"
      },
      {
        "name": "margin-right",
        "description": "For HTML output, sets the `margin-right` property on the Body element.\n\nFor LaTeX output, sets the right margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the right margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the right page margin.\n"
      },
      {
        "name": "margin-top",
        "description": "For HTML output, sets the `margin-top` property on the Body element.\n\nFor LaTeX output, sets the top margin if `geometry` is not \nused (otherwise `geometry` overrides this value)\n\nFor ConTeXt output, sets the top margin if `layout` is not used, \notherwise `layout` overrides these.\n\nFor `wkhtmltopdf` sets the top page margin.\n"
      },
      {
        "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": "code",
    "title": "Code",
    "options": [
      {
        "name": "code-fold",
        "description": "Collapse code into an HTML `<details>` tag so the user can display it on-demand.\n\n- `true`: collapse code\n- `false` (default): do not collapse code\n- `show`: use the `<details>` tag, but show the expanded code initially.\n"
      },
      {
        "name": "code-summary",
        "description": "Summary text to use for code blocks collapsed using `code-fold`"
      },
      {
        "name": "code-overflow",
        "description": "Choose how to handle code overflow, when code lines are too wide for their container. One of:\n\n- `scroll`\n- `wrap`\n"
      },
      {
        "name": "code-line-numbers",
        "description": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n  * `3,4,5`\n  * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n  * `1-3,5` \n  * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n  * `1-3|1-3,5` first shows `1-3`, then `1-3,5`\n  * `|5|5-10,12` first shows no numbering, then 5, then lines 5-10\n    and 12\n"
      },
      {
        "name": "code-copy",
        "description": "Enable a code copy icon for code blocks. \n\n- `true`: Always show the icon\n- `false`: Never show the icon\n- `hover` (default): Show the icon when the mouse hovers over the code block\n"
      },
      {
        "name": "code-link",
        "description": "Enables hyper-linking of functions within code blocks \nto their online documentation.\n\nCode linking is currently implemented only for the knitr engine \n(via the [downlit](https://downlit.r-lib.org/) package). \nA limitation of downlit currently prevents code linking \nif `code-line-numbers` is also `true`.\n"
      },
      {
        "name": "code-annotations",
        "description": "The style to use when displaying code annotations. Set this value\nto false to hide code annotations.\n"
      },
      {
        "name": "code-tools",
        "description": "Include a code tools menu (for hiding and showing code).\nUse `true` or `false` to enable or disable the standard code \ntools menu. Specify sub-properties `source`, `toggle`, and\n`caption` to customize the behavior and appearance of code tools.\n"
      },
      {
        "name": "code-block-border-left",
        "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n"
      },
      {
        "name": "code-block-bg",
        "description": "Specifies to apply a background color on code blocks. Provide a hex color to specify that the background color is\nenabled as well as the color of the background.\n\nFor PDF output, if you specify `false`  and `code-block-border-left` is `false` or not set, the code block is not enclosed in a floating LaTeX environment. This is especially useful for long code blocks nested inside a callout block, as it allows correct page breaks to occur. Line numbering and annotations are not affected.\n"
      },
      {
        "name": "highlight-style",
        "description": "Specifies the coloring style to be used in highlighted source code.\n\nInstead of a *STYLE* name, a JSON file with extension\n` .theme` may be supplied.  This will be parsed as a KDE\nsyntax highlighting theme and (if valid) used as the\nhighlighting style.\n"
      },
      {
        "name": "syntax-definitions",
        "description": "KDE language syntax definition files (XML)"
      },
      {
        "name": "indented-code-classes",
        "description": "Specify classes to use for all indented code blocks"
      }
    ]
  },
  {
    "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 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"
      },
      {
        "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-align",
        "description": "Figure horizontal alignment (`default`, `left`, `right`, or `center`)"
      },
      {
        "name": "fig-cap-location",
        "description": "Where to place figure captions (`top`, `bottom`, or `margin`)"
      },
      {
        "name": "fig-width",
        "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"
      },
      {
        "name": "fig-height",
        "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"
      },
      {
        "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.\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"
      },
      {
        "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": "fig-responsive",
        "description": "Whether to make images in this document responsive."
      }
    ]
  },
  {
    "name": "lightbox",
    "title": "Lightbox Figures",
    "options": [
      {
        "name": "lightbox",
        "description": "Enable or disable lightbox treatment for images in this document. See [Lightbox Figures](https://quarto.org/docs/output-formats/html-lightbox-figures.html) for more details."
      }
    ]
  },
  {
    "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": "tbl-cap-location",
        "description": "Where to place table captions (`top`, `bottom`, or `margin`)"
      },
      {
        "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": "links",
    "title": "Links",
    "options": [
      {
        "name": "link-external-icon",
        "description": "Show a special icon next to links that leave the current site."
      },
      {
        "name": "link-external-newwindow",
        "description": "Open external links in a new browser window or tab (rather than navigating the current tab)."
      },
      {
        "name": "link-external-filter",
        "description": "A regular expression that can be used to determine whether a link is an internal link. For example, \nthe following will treat links that start with http://www.quarto.org as internal links (and others\nwill be considered external):\n\n```\n^(?:http:|https:)\\/\\/www\\.quarto\\.org\\/custom\n```\n"
      },
      {
        "name": "format-links",
        "description": "Controls whether links to other rendered formats are displayed in HTML output.\n\nPass `false` to disable the display of format lengths or pass a list of format names for which you'd\nlike links to be shown.\n"
      },
      {
        "name": "notebook-links",
        "description": "Controls the display of links to notebooks that provided embedded content or are created from documents.\n\nSpecify `false` to disable linking to source Notebooks. Specify `inline` to show links to source notebooks beneath the content they provide. \nSpecify `global` to show a set of global links to source notebooks.\n"
      },
      {
        "name": "other-links",
        "description": "A list of links that should be displayed below the table of contents in an `Other Links` section."
      },
      {
        "name": "code-links",
        "description": "A list of links that should be displayed below the table of contents in an `Code Links` section."
      },
      {
        "name": "notebook-view",
        "description": "Configures the HTML viewer for notebooks that provide embedded content."
      },
      {
        "name": "notebook-preview-options",
        "description": "Options for controlling the display and behavior of Notebook previews."
      },
      {
        "name": "canonical-url",
        "description": "Include a canonical link tag in website pages. You may pass either `true` to \nautomatically generate a canonical link, or pass a canonical url that you'd like\nto have placed in the `href` attribute of the tag.\n\nCanonical links can only be generated for websites with a known `site-url`.\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": "citations-hover",
        "description": "Enables a hover popup for citation that shows the reference information."
      },
      {
        "name": "citation-location",
        "description": "Where citation information should be displayed (`document` or `margin`)"
      },
      {
        "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": "footnotes-hover",
        "description": "Enables a hover popup for footnotes that shows the footnote contents."
      },
      {
        "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": "crossref",
    "title": "Cross-References",
    "options": [
      {
        "name": "crossref",
        "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",
        "description": "Enables a hover popup for cross references that shows the item being referenced."
      }
    ]
  },
  {
    "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 `<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"
      },
      {
        "name": "include-after-body",
        "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"
      },
      {
        "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": "resources",
        "description": "Path (or glob) to files to publish with this document."
      },
      {
        "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": "metadata",
    "title": "Metadata",
    "options": [
      {
        "name": "keywords",
        "description": "List of keywords to be included in the document metadata."
      },
      {
        "name": "copyright",
        "description": "The copyright for this document, if any."
      },
      {
        "name": "license",
        "description": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC`, `CC BY-NC-SA`, and `CC BY-NC-ND` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n"
      },
      {
        "name": "pagetitle",
        "description": "Sets the title metadata for the document"
      },
      {
        "name": "title-prefix",
        "description": "Specify STRING as a prefix at the beginning of the title that appears in \nthe HTML header (but not in the title as it appears at the beginning of the body)\n"
      },
      {
        "name": "description-meta",
        "description": "Sets the description metadata for the document"
      },
      {
        "name": "author-meta",
        "description": "Sets the author metadata for the document"
      },
      {
        "name": "date-meta",
        "description": "Sets the date metadata for the document"
      }
    ]
  },
  {
    "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": "embed-resources",
        "description": "Produce a standalone HTML file with no external dependencies, using\n`data:` URIs to incorporate the contents of linked scripts, stylesheets,\nimages, and videos. The resulting file should be \"self-contained,\" in the\nsense that it needs no external files and no net access to be displayed\nproperly by a browser. This option works only with HTML output formats,\nincluding `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`, `slidy`,\n`slideous`, `dzslides`, and `revealjs`. Scripts, images, and stylesheets at\nabsolute URLs will be downloaded; those at relative URLs will be sought\nrelative to the working directory (if the first source\nfile is local) or relative to the base URL (if the first source\nfile is remote).  Elements with the attribute\n`data-external=\"1\"` will be left alone; the documents they\nlink to will not be incorporated in the document.\nLimitation: resources that are loaded dynamically through\nJavaScript cannot be incorporated; as a result, some\nadvanced features (e.g.  zoom or speaker notes) may not work\nin an offline \"self-contained\" `reveal.js` slide show.\n"
      },
      {
        "name": "self-contained-math",
        "description": "Embed math libraries (e.g. MathJax) within `self-contained` output.\nNote that math libraries are not embedded by default because they are \n quite large and often time consuming to download.\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": "Specify 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": "ipynb-shell-interactivity",
        "description": "Specify which nodes should be run interactively (displaying output from expressions)\n"
      },
      {
        "name": "plotly-connected",
        "description": "If true, use the \"notebook_connected\" plotly renderer, which downloads\nits dependencies from a CDN and requires an internet connection to view.\n"
      },
      {
        "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.\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": "html-table-processing",
        "description": "If `none`, do not process tables in HTML input."
      }
    ]
  },
  {
    "name": "website",
    "title": "Website",
    "options": [
      {
        "name": "search",
        "description": "Setting this to false prevents this document from being included in searches."
      },
      {
        "name": "repo-actions",
        "description": "Setting this to false prevents the `repo-actions` from appearing on this page."
      },
      {
        "name": "aliases",
        "description": "URLs that alias this document, when included in a website."
      },
      {
        "name": "image",
        "description": "The path to a preview image for this content. By default, \nQuarto will use the image value from the site: metadata. \nIf you provide an image, you may also optionally provide \nan image-width and image-height to improve \nthe appearance of your Twitter Card.\n\nIf image is not provided, Quarto will automatically attempt \nto locate a preview image.\n"
      },
      {
        "name": "image-height",
        "description": "The height of the preview image for this document."
      },
      {
        "name": "image-width",
        "description": "The width of the preview image for this document."
      },
      {
        "name": "image-alt",
        "description": "The alt text for preview image on this page."
      },
      {
        "name": "image-lazy-loading",
        "description": "Enables lazy loading for the preview image. If true, the preview image element \nwill have `loading=\"lazy\"`, and will only load when it comes into view.\n\nIf false, the preview image will load immediately.\n"
      }
    ]
  },
  {
    "name": "text",
    "title": "Text Output",
    "options": [
      {
        "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"
      }
    ]
  }
]