Path: blob/main/src/resources/schema/definitions.yml
12921 views
- id: date1anyOf:2- string3- object:4properties:5value: string6format: string7required: [value]89- id: date-format10schema: string1112- id: math-methods13enum:14values: [plain, webtex, gladtex, mathml, mathjax, katex]1516- id: pandoc-format-request-headers17arrayOf:18arrayOf:19schema: string20length: 22122- id: pandoc-format-output-file23anyOf:24- path25- enum:26values: [null]27hidden: true2829- id: filter-entry-point30enum:31[32pre-ast,33post-ast,34pre-quarto,35post-quarto,36pre-render,37post-render,38pre-finalize,39post-finalize,40]4142- id: pandoc-format-filters43arrayOf:44anyOf:45- path46- object:47properties:48type: string49path: path50required: [path]51- object:52properties:53type: string54path: path55at:56ref: filter-entry-point57required: [path, at]58- record:59type:60enum: [citeproc]6162- id: pandoc-shortcodes63arrayOf: path6465- id: page-column66enum:67[68body,69body-outset,70body-outset-left,71body-outset-right,72page,73page-left,74page-right,75page-inset,76page-inset-left,77page-inset-right,78screen,79screen-left,80screen-right,81screen-inset,82screen-inset-shaded,83screen-inset-left,84screen-inset-right,85margin,86]8788- id: contents-auto89object:90properties:91auto:92anyOf:93- boolean94- maybeArrayOf: string95description:96short: Automatically generate sidebar contents.97long: |98Automatically generate sidebar contents. Pass `true` to include all documents99in the site, a directory name to include only documents in that directory,100or a glob (or list of globs) to include documents based on a pattern.101102Subdirectories will create sections (use an `index.qmd` in the directory to103provide its title). Order will be alphabetical unless a numeric `order` field104is provided in document metadata.105106- id: navigation-item107anyOf:108- path109- ref: navigation-item-object110111- id: navigation-item-object112object:113closed: true114properties:115aria-label:116string:117description: "Accessible label for the item."118file:119hidden: true120string:121description: |122Alias for href123href:124string:125description: |126Link to file contained with the project or external URL127icon:128string:129description:130short: Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)131long: |132Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)133See <https://icons.getbootstrap.com/> for a list of available icons134id:135# "core identification"136# this field is only used in typescript137schema: string138hidden: true139menu:140arrayOf:141schema:142ref: navigation-item143text:144string:145description: |146Text to display for item (defaults to the147document title if not provided)148url:149hidden: true150string:151description: |152Alias for href153rel:154string:155description: |156Value for rel attribute. Multiple space-separated values are permitted.157See <https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel>158for a details.159target:160string:161description: |162Value for target attribute.163See <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target>164for details.165166- id: giscus-themes167enum:168values:169[170light,171light_high_contrast,172light_protanopia,173light_tritanopia,174dark,175dark_high_contrast,176dark_protanopia,177dark_tritanopia,178dark_dimmed,179transparent_dark,180cobalt,181purple_dark,182noborder_light,183noborder_dark,184noborder_gray,185preferred_color_scheme,186]187188- id: giscus-configuration189object:190closed: true191properties:192repo:193string:194description:195short: The Github repo that will be used to store comments.196long: |197The Github repo that will be used to store comments.198199In order to work correctly, the repo must be public, with the giscus app installed, and200the discussions feature must be enabled.201repo-id:202string:203description:204short: The Github repository identifier.205long: |206The Github repository identifier.207208You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).209If this is not provided, Quarto will attempt to discover it at render time.210category:211string:212description:213short: The discussion category where new discussions will be created.214long: |215The discussion category where new discussions will be created. It is recommended216to use a category with the **Announcements** type so that new discussions217can only be created by maintainers and giscus.218category-id:219string:220description:221short: The Github category identifier.222long: |223The Github category identifier.224225You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).226If this is not provided, Quarto will attempt to discover it at render time.227mapping:228schema:229anyOf:230- string231- number232completions:233- pathname234- url235- title236- og:title237description:238short: The mapping between the page and the embedded discussion.239long: |240The mapping between the page and the embedded discussion.241242- `pathname`: The discussion title contains the page path243- `url`: The discussion title contains the page url244- `title`: The discussion title contains the page title245- `og:title`: The discussion title contains the `og:title` metadata value246- any other string or number: Any other strings will be passed through verbatim and a discussion title247containing that value will be used. Numbers will be treated248as a discussion number and automatic discussion creation is not supported.249reactions-enabled:250boolean:251description: Display reactions for the discussion's main post before the comments.252loading:253enum: [lazy]254description: "Specify `loading: lazy` to defer loading comments until the user scrolls near the comments container."255input-position:256enum: [top, bottom]257description: Place the comment input box above or below the comments.258theme:259anyOf:260- string261- ref: giscus-themes262- object:263closed: true264properties:265light:266anyOf:267- string268- ref: giscus-themes269description: The light theme name.270dark:271anyOf:272- string273- ref: giscus-themes274description: The dark theme name.275276description:277short: The giscus theme to use when displaying comments.278long: |279The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key:280281```yaml282website:283comments:284giscus:285theme:286light: light # giscus theme used for light website theme287dark: dark_dimmed # giscus theme used for dark website theme288```289language:290string:291description: The language that should be used when displaying the commenting interface.292required: [repo]293294- id: external-engine295schema:296object:297closed: true298properties:299path:300path:301description: Path to the TypeScript module for the execution engine302required: [path]303description: An execution engine not pre-loaded in Quarto304305- id: document-comments-configuration306anyOf:307- enum: [false]308- object:309closed: true310properties:311utterances:312object:313closed: true314properties:315repo:316string:317description: The Github repo that will be used to store comments.318label:319string:320description: The label that will be assigned to issues created by Utterances.321theme:322string:323description:324short: The Github theme that should be used for Utterances.325long: |326The Github theme that should be used for Utterances327(`github-light`, `github-dark`, `github-dark-orange`,328`icy-dark`, `dark-blue`, `photon-dark`, `body-light`,329or `gruvbox-dark`)330completions:331- github-light332- github-dark333- github-dark-orange334- icy-dark335- dark-blue336- photon-dark337- body-light338- gruvbox-dark339issue-term:340string:341description:342short: How posts should be mapped to Github issues343long: |344How posts should be mapped to Github issues345(`pathname`, `url`, `title` or `og:title`)346completions:347- pathname348- url349- title350- og:title351required: [repo]352giscus:353ref: giscus-configuration354hypothesis:355anyOf:356- boolean357- object:358closed: true359properties:360client-url:361string:362description: Override the default hypothesis client url with a custom client url.363openSidebar:364boolean:365default: false366description: Controls whether the sidebar opens automatically on startup.367showHighlights:368anyOf:369- boolean370- enum: ["always", "whenSidebarOpen", "never"]371default: "always"372description: Controls whether the in-document highlights are shown by default (`always`, `whenSidebarOpen` or `never`)373theme:374enum: ["classic", "clean"]375default: classic376description: Controls the overall look of the sidebar (`classic` or `clean`)377enableExperimentalNewNoteButton:378boolean:379default: false380description: |381Controls whether the experimental New Note button382should be shown in the notes tab in the sidebar.383usernameUrl:384schema: string385description: |386Specify a URL to direct a user to,387in a new tab. when they click on the annotation author388link in the header of an annotation.389services:390arrayOf:391object:392properties:393apiUrl:394string:395description: The base URL of the service API.396authority:397string:398description: The domain name which the annotation service is associated with.399grantToken:400string:401description: An OAuth 2 grant token which the client can send to the service in order to get an access token for making authenticated requests to the service.402allowLeavingGroups:403boolean:404default: true405description: A flag indicating whether users should be able to leave groups of which they are a member.406enableShareLinks:407boolean:408default: true409description: A flag indicating whether annotation cards should show links that take the user to see an annotation in context.410groups:411anyOf:412- enum: ["$rpc:requestGroups"]413- arrayOf: string414description: An array of Group IDs or the literal string `$rpc:requestGroups`415icon:416string:417description: The URL to an image for the annotation service. This image will appear to the left of the name of the currently selected group.418required: [apiUrl, authority, grantToken]419description: |420Alternative annotation services which the client should421connect to instead of connecting to the public Hypothesis422service at hypothes.is.423branding:424object:425properties:426accentColor:427string:428description: Secondary color for elements of the commenting UI.429appBackgroundColor:430string:431description: The main background color of the commenting UI.432ctaBackgroundColor:433string:434description: The background color for call to action buttons.435selectionFontFamily:436string:437description: The font family for selection text in the annotation card.438annotationFontFamily:439string:440description: The font family for the actual annotation value that the user writes about the page or selection.441description: Settings to adjust the commenting sidebar's look and feel.442externalContainerSelector:443string:444description: A CSS selector specifying the containing element into which the sidebar iframe will be placed.445focus:446object:447properties:448user:449object:450properties:451username:452string:453description: The username of the user to focus on.454userid:455string:456description: The userid of the user to focus on.457displayName:458string:459description: The display name of the user to focus on.460required: [user]461description: Defines a focused filter set for the available annotations on a page.462requestConfigFromFrame:463object:464properties:465origin:466string:467description: Host url and port number of receiving iframe468ancestorLevel:469number:470description: Number of nested iframes deep the client is relative from the receiving iframe.471assetRoot:472string:473description: The root URL from which assets are loaded.474sidebarAppUrl:475string:476description: The URL for the sidebar application which displays annotations.477default: "https://hypothes.is/app.html"478479- id: social-metadata480object:481closed: true482properties:483title:484string:485description:486short: "The title of the page"487long: |488The title of the page. Note that by default Quarto will automatically489use the title metadata from the page. Specify this field if you’d like490to override the title for this provider.491description:492string:493description:494short: "A short description of the content."495long: |496A short description of the content. Note that by default Quarto will497automatically use the description metadata from the page. Specify this498field if you’d like to override the description for this provider.499image:500path:501description:502short: "The path to a preview image for the content."503long: |504The path to a preview image for the content. By default, Quarto will use505the `image` value from the format metadata. If you provide an506image, you may also optionally provide an `image-width` and `image-height`.507image-alt:508path:509description:510short: "The alt text for the preview image."511long: |512The alt text for the preview image. By default, Quarto will use513the `image-alt` value from the format metadata. If you provide an514image, you may also optionally provide an `image-width` and `image-height`.515image-width:516number:517description: "Image width (pixels)"518image-height:519number:520description: "Image height (pixels)"521522- id: page-footer-region523anyOf:524- string525- arrayOf:526ref: navigation-item527528- id: sidebar-contents529anyOf:530- string531- ref: contents-auto532- arrayOf:533anyOf:534- ref: navigation-item535- path536- object:537closed: true538properties:539section:540anyOf:541- string542- null543contents:544ref: sidebar-contents545- ref: contents-auto546547- id: project-preview548object:549closed: true550properties:551port:552number:553description: Port to listen on (defaults to random value between 3000 and 8000)554host:555string:556description: Hostname to bind to (defaults to 127.0.0.1)557serve:558description: Use an exernal application to preview the project.559schema:560ref: project-serve561browser:562boolean:563description: Open a web browser to view the preview (defaults to true)564watch-inputs:565boolean:566description: Re-render input files when they change (defaults to true)567navigate:568boolean:569description: Navigate the browser automatically when outputs are updated (defaults to true)570timeout:571number:572description: Time (in seconds) after which to exit if there are no active clients573574- id: project-serve575object:576closed: true577properties:578cmd:579string:580description: |581Serve project preview using the specified command.582Interpolate the `--port` into the command using `{port}`.583args:584string:585description: Additional command line arguments for preview command.586env:587object:588description: Environment variables to set for preview command.589ready:590string:591description: Regular expression for detecting when the server is ready.592required: [cmd, ready]593594- id: publish595description: Sites published from project596schema:597object:598closed: true599properties:600netlify:601arrayOf:602ref: publish-record603description: "Sites published to Netlify"604605- id: publish-record606object:607closed: true608properties:609id:610string:611description: "Unique identifier for site"612url:613string:614description: "Published URL for site"615616- id: twitter-card-config617object:618super:619resolveRef: social-metadata620closed: true621properties:622card-style:623enum: [summary, summary_large_image]624description:625short: "Card style"626long: |627Card style (`summary` or `summary_large_image`).628629If this is not provided, the best style will automatically630selected based upon other metadata. You can learn more about Twitter Card631styles [here](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards).632creator:633string:634description: "`@username` of the content creator (must be a quoted string)"635site:636string:637description: "`@username` of the website (must be a quoted string)"638639- id: open-graph-config640object:641super:642resolveRef: social-metadata643closed: true644properties:645locale:646string:647description: "Locale of open graph metadata"648site-name:649string:650description:651short: "Name that should be displayed for the overall site"652long: |653Name that should be displayed for the overall site. If not explicitly654provided in the `open-graph` metadata, Quarto will use the website or655book `title` by default.656657- id: page-footer658object:659properties:660left:661ref: page-footer-region662description: "Footer left content"663right:664ref: page-footer-region665description: "Footer right content"666center:667ref: page-footer-region668description: "Footer center content"669border:670anyOf:671- boolean672- string673description: "Footer border (`true`, `false`, or a border color)"674background:675schema: string676description: "Footer background color"677foreground:678schema: string679description: "Footer foreground color"680closed: true681682- id: base-website683object:684closed: true685properties:686title:687string:688description: "Website title"689description:690string:691description: "Website description"692favicon:693string:694description: "The path to the favicon for this website"695site-url:696string:697description: "Base URL for published website"698site-path:699string:700description: |701Path to site (defaults to `/`). Not required if you specify `site-url`.702repo-url:703string:704description: "Base URL for website source code repository"705repo-link-target:706string:707description: "The value of the target attribute for repo links"708repo-link-rel:709string:710description: "The value of the rel attribute for repo links"711repo-subdir:712string:713description: "Subdirectory of repository containing website"714repo-branch:715string:716description: "Branch of website source code (defaults to `main`)"717issue-url:718string:719description: "URL to use for the 'report an issue' repository action."720repo-actions:721maybeArrayOf:722enum: [none, edit, source, issue]723description:724short: "Links to source repository actions"725long: "Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`)"726reader-mode:727boolean:728description: |729Displays a 'reader-mode' tool which allows users to hide the sidebar and table of contents when viewing a page.730llms-txt:731boolean:732description: |733Generate llms.txt and .llms.md files for LLM-friendly content consumption.734google-analytics:735anyOf:736- string737- object:738properties:739tracking-id:740schema: string741description: "The Google tracking Id or measurement Id of this website."742storage:743enum: [cookies, none]744description:745short: "Storage options for Google Analytics data"746long: |747Storage option for Google Analytics data using on of these two values:748749`cookies`: Use cookies to store unique user and session identification (default).750751`none`: Do not use cookies to store unique user and session identification.752753For more about choosing storage options see [Storage](https://quarto.org/docs/websites/website-tools.html#storage).754anonymize-ip:755schema: boolean756description:757short: "Anonymize the user ip address."758long: |759Anonymize the user ip address. For more about this feature, see760[IP Anonymization (or IP masking) in Google Analytics](https://support.google.com/analytics/answer/2763052?hl=en).761version:762enum: [3, 4]763description:764short: "The version number of Google Analytics to use."765long: |766The version number of Google Analytics to use.767768- `3`: Use analytics.js769- `4`: use gtag.770771This is automatically detected based upon the `tracking-id`, but you may specify it.772description: "Enable Google Analytics for this website"773plausible-analytics:774anyOf:775- string776- object:777closed: true778properties:779path:780path:781description: "Path to a file containing the Plausible Analytics script snippet"782required: [path]783description:784short: "Enable Plausible Analytics for this website by providing a script snippet or path to snippet file"785long: |786Enable Plausible Analytics for this website by pasting the script snippet from your Plausible dashboard,787or by providing a path to a file containing the snippet.788789Plausible is a privacy-friendly, GDPR-compliant web analytics service that does not use cookies and does not require cookie consent.790791**Option 1: Inline snippet**792793```yaml794website:795plausible-analytics: |796<script async src="https://plausible.io/js/script.js"></script>797```798799**Option 2: File path**800801```yaml802website:803plausible-analytics:804path: _plausible_snippet.html805```806807To get your script snippet:8088091. Log into your Plausible account at <https://plausible.io>8102. Go to your site settings8113. Copy the JavaScript snippet provided8124. Either paste it directly in your configuration or save it to a file813814For more information, see <https://plausible.io/docs/plausible-script>815announcement:816anyOf:817- string818- object:819properties:820content:821schema: string822description: "The content of the announcement"823dismissable:824schema: boolean825description: "Whether this announcement may be dismissed by the user."826icon:827schema: string828description:829short: "The icon to display in the announcement"830long: |831Name of bootstrap icon (e.g. `github`, `twitter`, `share`) for the announcement.832See <https://icons.getbootstrap.com/> for a list of available icons833position:834schema:835enum: ["above-navbar", "below-navbar"]836description:837short: "The position of the announcement."838long: |839The position of the announcement. One of `above-navbar` (default) or `below-navbar`.840type:841schema:842enum:843[844primary,845secondary,846success,847danger,848warning,849info,850light,851dark,852]853description:854short: "The type of announcement. Affects the appearance of the announcement."855long: |856The type of announcement. One of `primary`, `secondary`, `success`, `danger`, `warning`,857`info`, `light` or `dark`. Affects the appearance of the announcement.858859description: Provides an announcement displayed at the top of the page.860cookie-consent:861anyOf:862- enum: [express, implied]863- boolean864- object:865properties:866type:867enum: [express, implied]868description:869short: "The type of consent that should be requested"870long: |871The type of consent that should be requested, using one of these two values:872873- `express` (default): This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn’t agree).874875- `implied`: This will notify the user that the site uses cookies and permit them to change preferences, but not block cookies unless the user changes their preferences.876877style:878enum: [simple, headline, interstitial, standalone]879description:880short: "The style of the consent banner that is displayed"881long: |882The style of the consent banner that is displayed:883884- `simple` (default): A simple dialog in the lower right corner of the website.885886- `headline`: A full width banner across the top of the website.887888- `interstitial`: An semi-transparent overlay of the entire website.889890- `standalone`: An opaque overlay of the entire website.891palette:892enum: [light, dark]893description: "Whether to use a dark or light appearance for the consent banner (`light` or `dark`)."894policy-url:895schema: string896description: "The url to the website’s cookie or privacy policy."897language:898schema: string899description:900short: "The language to be used when diplaying the cookie consent prompt (defaults to document language)."901long: |902The language to be used when diplaying the cookie consent prompt specified using an IETF language tag.903904If not specified, the document language will be used.905prefs-text:906schema: string907description:908short: "The text to display for the cookie preferences link in the website footer."909description:910short: "Request cookie consent before enabling scripts that set cookies"911long: |912Quarto includes the ability to request cookie consent before enabling scripts that set cookies, using [Cookie Consent](https://www.cookieconsent.com/).913914The user’s cookie preferences will automatically control Google Analytics (if enabled) and can be used to control custom scripts you add as well. For more information see [Custom Scripts and Cookie Consent](https://quarto.org/docs/websites/website-tools.html#custom-scripts-and-cookie-consent).915search:916anyOf:917- boolean918- object:919properties:920location:921enum: [navbar, sidebar]922description: "Location for search widget (`navbar` or `sidebar`)"923type:924enum: [overlay, textbox]925description: "Type of search UI (`overlay` or `textbox`)"926limit:927schema: number928description: "Number of matches to display (defaults to 20)"929collapse-after:930schema: number931description: "Matches after which to collapse additional results"932copy-button:933schema: boolean934description: "Provide button for copying search link"935merge-navbar-crumbs:936schema: boolean937default: true938description: "When false, do not merge navbar crumbs into the crumbs in `search.json`."939keyboard-shortcut:940maybeArrayOf:941string:942description: "One or more keys that will act as a shortcut to launch search (single characters)"943show-item-context:944schema:945anyOf:946- enum: ["tree", "parent", "root"]947- boolean948description: "Whether to include search result parents when displaying items in search results (when possible)."949algolia:950object:951properties:952index-name:953schema: string954description: "The name of the index to use when performing a search"955application-id:956schema: string957description: "The unique ID used by Algolia to identify your application"958search-only-api-key:959schema: string960description: "The Search-Only API key to use to connect to Algolia"961analytics-events:962boolean:963description: "Enable tracking of Algolia analytics events"964show-logo:965boolean:966description: "Enable the display of the Algolia logo in the search results footer."967index-fields:968object:969properties:970href:971schema: string972description: "Field that contains the URL of index entries"973title:974schema: string975description: "Field that contains the title of index entries"976text:977schema: string978description: "Field that contains the text of index entries"979section:980schema: string981description: "Field that contains the section of index entries"982closed: true983params:984object:985description: "Additional parameters to pass when executing a search"986closed: true987description: "Use external Algolia search index"988closed: true989description: "Provide full text search for website"990991navbar:992anyOf:993- boolean994- object:995properties:996title:997anyOf:998- string999- boolean1000description: "The navbar title. Uses the project title if none is specified."1001logo:1002ref: logo-light-dark-specifier1003description: "Specification of image that will be displayed to the left of the title."1004logo-alt:1005string:1006description: "Alternate text for the logo image."1007logo-href:1008string:1009description: "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."1010background:1011string:1012description: "The navbar's background color (named or hex color)."1013completions:1014- primary1015- secondary1016- success1017- danger1018- warning1019- info1020- light1021- dark1022foreground:1023string:1024description: "The navbar's foreground color (named or hex color)."1025completions:1026- primary1027- secondary1028- success1029- danger1030- warning1031- info1032- light1033- dark1034search:1035boolean:1036description: "Include a search box in the navbar."1037pinned:1038boolean:1039description: "Always show the navbar (keeping it pinned)."1040default: false1041collapse:1042boolean:1043description: "Collapse the navbar into a menu when the display becomes narrow."1044default: true1045collapse-below:1046enum: [sm, md, lg, xl, xxl]1047description: "The responsive breakpoint below which the navbar will collapse into a menu (`sm`, `md`, `lg` (default), `xl`, `xxl`)."1048default: "lg"1049left:1050arrayOf:1051ref: navigation-item1052description: "List of items for the left side of the navbar."1053right:1054arrayOf:1055ref: navigation-item1056description: "List of items for the right side of the navbar."1057toggle-position:1058schema:1059enum: [left, right]1060description: "The position of the collapsed navbar toggle when in responsive mode"1061default: "left"1062tools-collapse:1063boolean:1064description: "Collapse tools into the navbar menu when the display becomes narrow."1065default: false10661067description: "Top navigation options"10681069sidebar:1070anyOf:1071- boolean1072- maybeArrayOf:1073object:1074properties:1075id:1076string:1077description: "The identifier for this sidebar."1078title:1079anyOf:1080- string1081- boolean1082description: "The sidebar title. Uses the project title if none is specified."1083logo:1084ref: logo-light-dark-specifier1085description: "Specification of image that will be displayed in the sidebar."1086logo-alt:1087string:1088description: "Alternate text for the logo image."1089logo-href:1090string:1091description: "Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html)."1092search:1093boolean:1094description: "Include a search control in the sidebar."1095tools:1096arrayOf:1097ref: navigation-item-object1098description: "List of sidebar tools"1099contents:1100ref: sidebar-contents1101description: "List of items for the sidebar"1102style:1103enum: ["docked", "floating"]1104description: "The style of sidebar (`docked` or `floating`)."1105default: "floating"1106background:1107schema: string1108completions:1109- primary1110- secondary1111- success1112- danger1113- warning1114- info1115- light1116- dark1117description: "The sidebar's background color (named or hex color)."1118foreground:1119schema: string1120completions:1121- primary1122- secondary1123- success1124- danger1125- warning1126- info1127- light1128- dark1129description: "The sidebar's foreground color (named or hex color)."1130border:1131boolean:1132description: "Whether to show a border on the sidebar (defaults to true for 'docked' sidebars)"1133alignment:1134enum: ["left", "right", "center"]1135description: "Alignment of the items within the sidebar (`left`, `right`, or `center`)"1136collapse-level:1137number:1138description: "The depth at which the sidebar contents should be collapsed by default."1139default: 21140pinned:1141boolean:1142description: "When collapsed, pin the collapsed sidebar to the top of the page."1143header:1144maybeArrayOf: string1145description: "Markdown to place above sidebar content (text or file path)"1146footer:1147maybeArrayOf: string1148description: "Markdown to place below sidebar content (text or file path)"1149description: "Side navigation options"1150body-header:1151string:1152description: "Markdown to insert at the beginning of each page’s body (below the title and author block)."1153body-footer:1154string:1155description: "Markdown to insert below each page’s body."1156margin-header:1157maybeArrayOf: string1158description: "Markdown to place above margin content (text or file path)"1159margin-footer:1160maybeArrayOf: string1161description: "Markdown to place below margin content (text or file path)"1162page-navigation:1163boolean:1164description: "Provide next and previous article links in footer"1165back-to-top-navigation:1166boolean:1167description: "Provide a 'back to top' navigation button"1168bread-crumbs:1169boolean:1170description: "Whether to show navigation breadcrumbs for pages more than 1 level deep"1171page-footer:1172anyOf:1173- string1174- ref: page-footer1175description: "Shared page footer"1176image:1177path:1178description: |1179Default site thumbnail image for `twitter` /`open-graph`1180image-alt:1181path:1182description: |1183Default site thumbnail image alt text for `twitter` /`open-graph`1184comments:1185schema:1186ref: document-comments-configuration11871188open-graph:1189anyOf:1190- boolean1191- ref: open-graph-config1192description: "Publish open graph metadata"1193twitter-card:1194anyOf:1195- boolean1196- ref: twitter-card-config1197description: "Publish twitter card metadata"1198other-links:1199schema:1200ref: other-links1201tags:1202formats: [$html-doc]1203description: "A list of other links to appear below the TOC."1204code-links:1205schema:1206anyOf:1207- boolean1208- ref: code-links-schema1209tags:1210formats: [$html-doc]1211description: "A list of code links to appear with this document."1212drafts:1213schema:1214maybeArrayOf: path1215description: "A list of input documents that should be treated as drafts"1216draft-mode:1217schema:1218enum: ["visible", "unlinked", "gone"]1219description:1220short: "How to handle drafts that are encountered."1221long: |1222How to handle drafts that are encountered.12231224`visible` - the draft will visible and fully available1225`unlinked` - the draft will be rendered, but will not appear in navigation, search, or listings.1226`gone` - the draft will have no content and will not be linked to (default).12271228- id: book-schema1229schema:1230object:1231closed: true1232super:1233resolveRef: base-website1234properties:1235title:1236string:1237description: "Book title"1238subtitle:1239string:1240description: "Book subtitle"1241author:1242maybeArrayOf:1243anyOf: [string, object]1244description: "Author or authors of the book"1245date:1246string:1247description: "Book publication date"1248date-format:1249string:1250description: "Format string for dates in the book"1251abstract:1252string:1253description: "Book abstract"1254description:1255string:1256description: "Description metadata for HTML version of book"1257chapters:1258schema:1259ref: chapter-list1260description: "Book part and chapter files"1261hidden: true1262appendices:1263schema:1264ref: chapter-list1265description: "Book appendix files"1266hidden: true1267references:1268path:1269description: "Book references file"1270output-file:1271path:1272description: "Base name for single-file output (e.g. PDF, ePub, docx)"1273cover-image:1274path:1275description: "Cover image (used in HTML and ePub formats)"1276cover-image-alt:1277string:1278description: "Alternative text for cover image (used in HTML format)"1279sharing:1280maybeArrayOf:1281enum: [twitter, facebook, linkedin]1282description: |1283Sharing buttons to include on navbar or sidebar1284(one or more of `twitter`, `facebook`, `linkedin`)1285downloads:1286maybeArrayOf:1287enum: [pdf, epub, docx]1288description: |1289Download buttons for other formats to include on navbar or sidebar1290(one or more of `pdf`, `epub`, and `docx`)1291tools:1292arrayOf:1293schema:1294ref: navigation-item1295description: "Custom tools for navbar or sidebar"1296doi:1297string:1298tags:1299formats: [$html-doc]1300description: The Digital Object Identifier for this book.13011302- id: chapter-item1303anyOf:1304- ref: navigation-item1305- object:1306properties:1307part:1308string:1309description: "Part title or path to input file"1310chapters:1311arrayOf:1312ref: navigation-item1313description: "Path to chapter input file"1314required: [part]13151316- id: chapter-list1317arrayOf:1318ref: chapter-item13191320- id: other-links1321arrayOf:1322object:1323properties:1324text:1325string:1326description: "The text for the link."1327href:1328string:1329description: "The href for the link."1330icon:1331string:1332description: "The bootstrap icon name for the link."1333rel:1334string:1335description: "The rel attribute value for the link."1336target:1337string:1338description: "The target attribute value for the link."1339required: [text, href]13401341- id: crossref-labels-schema1342string:1343completions:1344- alpha1345- arabic1346- roman13471348- id: epub-contributor1349anyOf:1350- string1351- maybeArrayOf:1352object:1353closed: true1354properties:1355role:1356string:1357description:1358short: The role of this creator or contributor.1359long: |1360The role of this creator or contributor using1361[MARC relators](https://loc.gov/marc/relators/relaterm.html). Human readable1362translations to commonly used relators (e.g. 'author', 'editor') will1363attempt to be automatically translated.1364file-as:1365string:1366description: An alternate version of the creator or contributor text used for alphabatizing.1367text:1368string:1369description: The text describing the creator or contributor (for example, creator name).13701371- id: format-language1372object:1373properties:1374toc-title-document: string1375toc-title-website: string1376related-formats-title: string1377related-notebooks-title: string1378callout-tip-title: string1379callout-note-title: string1380callout-warning-title: string1381callout-important-title: string1382callout-caution-title: string1383section-title-abstract: string1384section-title-footnotes: string1385section-title-appendices: string1386code-summary: string1387code-tools-menu-caption: string1388code-tools-show-all-code: string1389code-tools-hide-all-code: string1390code-tools-view-source: string1391code-tools-source-code: string1392search-no-results-text: string1393copy-button-tooltip: string1394copy-button-tooltip-success: string1395repo-action-links-edit: string1396repo-action-links-source: string1397repo-action-links-issue: string1398search-matching-documents-text: string1399search-copy-link-title: string1400search-hide-matches-text: string1401search-more-match-text: string1402search-more-matches-text: string1403search-clear-button-title: string1404search-text-placeholder: string1405search-detached-cancel-button-title: string1406search-submit-button-title: string1407crossref-fig-title: string1408crossref-tbl-title: string1409crossref-lst-title: string1410crossref-thm-title: string1411crossref-lem-title: string1412crossref-cor-title: string1413crossref-prp-title: string1414crossref-cnj-title: string1415crossref-def-title: string1416crossref-exm-title: string1417crossref-exr-title: string1418crossref-fig-prefix: string1419crossref-tbl-prefix: string1420crossref-lst-prefix: string1421crossref-ch-prefix: string1422crossref-apx-prefix: string1423crossref-sec-prefix: string1424crossref-eq-prefix: string1425crossref-thm-prefix: string1426crossref-lem-prefix: string1427crossref-cor-prefix: string1428crossref-prp-prefix: string1429crossref-cnj-prefix: string1430crossref-def-prefix: string1431crossref-exm-prefix: string1432crossref-exr-prefix: string1433crossref-lof-title: string1434crossref-lot-title: string1435crossref-lol-title: string1436errorDescription: "be a format language description object"14371438- id: website-about1439object:1440closed: true1441required: [template]1442properties:1443id:1444string:1445description:1446short: "The target id for the about page."1447long: |1448The target id of this about page. When the about page is rendered, it will1449place read the contents of a `div` with this id into the about template that you1450have selected (and replace the contents with the rendered about content).14511452If no such `div` is defined on the page, a `div` with this id will be created1453and appended to the end of the page.1454template:1455anyOf:1456- enum: [jolla, trestles, solana, marquee, broadside]1457- path1458description:1459short: "The template to use to layout this about page."1460long: |1461The template to use to layout this about page. Choose from:14621463- `jolla`1464- `trestles`1465- `solana`1466- `marquee`1467- `broadside`1468image:1469path:1470description:1471short: "The path to the main image on the about page."1472long: |1473The path to the main image on the about page. If not specified,1474the `image` provided for the document itself will be used.1475image-alt:1476path:1477description: "The alt text for the main image on the about page."1478image-title:1479path:1480description: "The title for the main image on the about page."1481image-width:1482string:1483description:1484short: "A valid CSS width for the about page image."1485long: |1486A valid CSS width for the about page image.1487image-shape:1488enum: [rectangle, round, rounded]1489description:1490short: "The shape of the image on the about page."1491long: |1492The shape of the image on the about page.14931494- `rectangle`1495- `round`1496- `rounded`1497links:1498arrayOf:1499ref: navigation-item15001501- id: website-listing1502object:1503closed: true1504properties:1505id:1506string:1507description:1508short: "The id of this listing."1509long: |1510The id of this listing. When the listing is rendered, it will1511place the contents into a `div` with this id. If no such `div` is defined on the1512page, a `div` with this id will be created and appended to the end of the page.15131514If no `id` is provided for a listing, Quarto will synthesize one when rendering the page.1515type:1516enum: [default, table, grid, custom]1517description:1518short: "The type of listing to create."1519long: |1520The type of listing to create. Choose one of:15211522- `default`: A blog style list of items1523- `table`: A table of items1524- `grid`: A grid of item cards1525- `custom`: A custom template, provided by the `template` field1526contents:1527maybeArrayOf:1528anyOf:1529- string1530- ref: website-listing-contents-object1531description: "The files or path globs of Quarto documents or YAML files that should be included in the listing."1532sort:1533anyOf:1534- boolean1535- maybeArrayOf: string1536description:1537short: "Sort items in the listing by these fields."1538long: |1539Sort items in the listing by these fields. The sort key is made up of a1540field name followed by a direction `asc` or `desc`.15411542For example:1543`date asc`15441545Use `sort:false` to use the unsorted original order of items.1546max-items:1547number:1548description: The maximum number of items to include in this listing.1549page-size:1550number:1551description: The number of items to display on a page.1552sort-ui:1553anyOf:1554- boolean1555- arrayOf: string1556description:1557short: "Shows or hides the sorting control for the listing."1558long: |1559Shows or hides the sorting control for the listing. To control the1560fields that will be displayed in the sorting control, provide a list1561of field names.1562filter-ui:1563anyOf:1564- boolean1565- arrayOf: string1566description:1567short: "Shows or hides the filtering control for the listing."1568long: |1569Shows or hides the filtering control for the listing. To control the1570fields that will be used to filter the listing, provide a list1571of field names. By default all fields of the listing will be used1572when filtering.1573categories:1574anyOf:1575- boolean1576- enum: [numbered, unnumbered, cloud]1577description:1578short: "Display item categories from this listing in the margin of the page."1579long: |1580Display item categories from this listing in the margin of the page.15811582- `numbered`: Category list with number of items1583- `unnumbered`: Category list1584- `cloud`: Word cloud style categories15851586feed:1587anyOf:1588- boolean1589- object:1590closed: true1591properties:1592items:1593number:1594description: |1595The number of items to include in your feed. Defaults to 20.1596type:1597enum: [full, partial, metadata]1598description:1599short: Whether to include full or partial content in the feed.1600long: |1601Whether to include full or partial content in the feed.16021603- `full` (default): Include the complete content of the document in the feed.1604- `partial`: Include only the first paragraph of the document in the feed.1605- `metadata`: Use only the title, description, and other document metadata in the feed.1606title:1607string:1608description:1609short: The title for this feed.1610long: |1611The title for this feed. Defaults to the site title provided the Quarto project.1612image:1613path:1614description:1615short: The path to an image for this feed.1616long: |1617The path to an image for this feed. If not specified, the image for the page the listing1618appears on will be used, otherwise an image will be used if specified for the site1619in the Quarto project.1620description:1621string:1622description:1623short: The description of this feed.1624long: |1625The description of this feed. If not specified, the description for the page the1626listing appears on will be used, otherwise the description1627of the site will be used if specified in the Quarto project.1628language:1629string:1630description:1631short: The language of the feed.1632long: |1633The language of the feed. Omitted if not specified.1634See [https://www.rssboard.org/rss-language-codes](https://www.rssboard.org/rss-language-codes)1635for a list of valid language codes.1636categories:1637maybeArrayOf:1638string:1639description: A list of categories for which to create separate RSS feeds containing only posts with that category1640xml-stylesheet:1641path:1642description: The path to an XML stylesheet (XSL file) used to style the RSS feed.1643description: Enables an RSS feed for the listing.1644date-format:1645string:1646description:1647short: "The date format to use when displaying dates (e.g. d-M-yyy)."1648long: |1649The date format to use when displaying dates (e.g. d-M-yyy).1650Learn more about supported date formatting values [here](https://quarto.org/docs/reference/dates.html).1651max-description-length:1652number:1653description:1654short: "The maximum length (in characters) of the description displayed in the listing."1655long: |1656The maximum length (in characters) of the description displayed in the listing.1657Defaults to 175.1658image-placeholder:1659string:1660description: "The default image to use if an item in the listing doesn't have an image."1661image-lazy-loading:1662boolean:1663description: "If false, images in the listing will be loaded immediately. If true, images will be loaded as they come into view."1664default: true1665image-align:1666enum: [left, right]1667description: In `default` type listings, whether to place the image on the right or left side of the post content (`left` or `right`).1668image-height:1669string:1670description:1671short: "The height of the image being displayed."1672long: |1673The height of the image being displayed (a CSS height string).16741675The width is automatically determined and the image will fill the rectangle without scaling (cropped to fill).1676grid-columns:1677number:1678description:1679short: "In `grid` type listings, the number of columns in the grid display."1680long: |1681In grid type listings, the number of columns in the grid display.1682Defaults to 3.1683grid-item-border:1684boolean:1685description:1686short: "In `grid` type listings, whether to display a border around the item card."1687long: |1688In grid type listings, whether to display a border around the item card. Defaults to `true`.1689grid-item-align:1690enum: [left, right, center]1691description:1692short: "In `grid` type listings, the alignment of the content within the card."1693long: |1694In grid type listings, the alignment of the content within the card (`left` (default), `right`, or `center`).1695table-striped:1696boolean:1697description:1698short: "In `table` type listings, display the table rows with alternating background colors."1699long: |1700In table type listings, display the table rows with alternating background colors.1701Defaults to `false`.1702table-hover:1703boolean:1704description:1705short: "In `table` type listings, highlight rows of the table when the user hovers the mouse over them."1706long: |1707In table type listings, highlight rows of the table when the user hovers the mouse over them.1708Defaults to false.1709template:1710path:1711description:1712short: "The path to a custom listing template."1713long: |1714The path to a custom listing template.1715template-params:1716schema: object1717description: "Parameters that are passed to the custom template."1718fields:1719arrayOf: string1720description:1721short: "The list of fields to include in this listing"1722long: |1723The list of fields to include in this listing.1724field-display-names:1725object:1726description:1727short: "A mapping of display names for listing fields."1728long: |1729A mapping that provides display names for specific fields. For example, to display the title column as ‘Report’ in a table listing you would write:17301731```yaml1732listing:1733field-display-names:1734title: "Report"1735```1736field-types:1737object:1738description:1739short: "Provides the date type for the field of a listing item."1740long: |1741Provides the date type for the field of a listing item. Unknown fields are treated1742as strings unless a type is provided. Valid types are `date`, `number`.1743field-links:1744arrayOf: string1745description:1746short: "This list of fields to display as links in a table listing."1747long: |1748The list of fields to display as hyperlinks to the source document1749when the listing type is a table. By default, only the `title` or1750`filename` is displayed as a link.1751field-required:1752arrayOf: string1753description:1754short: "Fields that items in this listing must have populated."1755long: |1756Fields that items in this listing must have populated.1757If a listing is rendered and one more items in this listing1758is missing a required field, an error will occur and the render will.1759include:1760maybeArrayOf: object1761description: "Items with matching field values will be included in the listing."1762exclude:1763maybeArrayOf: object1764description: "Items with matching field values will be excluded from the listing."17651766- id: website-listing-contents-object1767object:1768properties:1769author:1770maybeArrayOf: string1771date: string1772title: string1773subtitle: string17741775- id: csl-date1776anyOf:1777- string1778- maybeArrayOf: number1779- object:1780properties:1781year:1782number:1783description: The year1784month:1785number:1786description: The month1787day:1788number:1789description: The day17901791- id: csl-person1792anyOf:1793- maybeArrayOf: string1794- maybeArrayOf:1795object:1796properties:1797family-name:1798string:1799description: The family name.1800given-name:1801string:1802description: The given name.18031804- id: csl-number1805anyOf:1806- number1807- string18081809- id: csl-item-shared1810object:1811properties:1812abstract-url:1813string:1814description: A url to the abstract for this item.1815accessed:1816ref: csl-date1817description: Date the item has been accessed.1818annote:1819string:1820description:1821short: Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review).1822long: |1823Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review);18241825For descriptive text (e.g., in an annotated bibliography), use `note` instead1826archive:1827string:1828description: Archive storing the item1829archive-collection:1830string:1831description: Collection the item is part of within an archive.1832archive_collection:1833schema: string1834hidden: true1835archive-location:1836string:1837description: Storage location within an archive (e.g. a box and folder number).1838archive_location:1839schema: string1840hidden: true1841archive-place:1842string:1843description: Geographic location of the archive.1844authority:1845string:1846description: Issuing or judicial authority (e.g. "USPTO" for a patent, "Fairfax Circuit Court" for a legal case).1847available-date:1848ref: csl-date1849description:1850short: Date the item was initially available1851long: |1852Date the item was initially available (e.g. the online publication date of a journal1853article before its formal publication date; the date a treaty was made available for signing).1854call-number:1855string:1856description: Call number (to locate the item in a library).1857chair:1858ref: csl-person1859description: The person leading the session containing a presentation (e.g. the organizer of the `container-title` of a `speech`).1860chapter-number:1861ref: csl-number1862description: Chapter number (e.g. chapter number in a book; track number on an album).1863citation-key:1864string:1865description:1866short: Identifier of the item in the input data file (analogous to BiTeX entrykey).1867long: |1868Identifier of the item in the input data file (analogous to BiTeX entrykey);18691870Use this variable to facilitate conversion between word-processor and plain-text writing systems;1871For an identifer intended as formatted output label for a citation1872(e.g. “Ferr78”), use `citation-label` instead1873citation-label:1874string:1875description:1876short: Label identifying the item in in-text citations of label styles (e.g. "Ferr78").1877long: |1878Label identifying the item in in-text citations of label styles (e.g. "Ferr78");18791880May be assigned by the CSL processor based on item metadata; For the identifier of the item1881in the input data file, use `citation-key` instead1882citation-number:1883schema:1884ref: csl-number1885description: Index (starting at 1) of the cited reference in the bibliography (generated by the CSL processor).1886hidden: true1887collection-editor:1888ref: csl-person1889description: Editor of the collection holding the item (e.g. the series editor for a book).1890collection-number:1891ref: csl-number1892description: Number identifying the collection holding the item (e.g. the series number for a book)1893collection-title:1894string:1895description: Title of the collection holding the item (e.g. the series title for a book; the lecture series title for a presentation).1896compiler:1897ref: csl-person1898description: Person compiling or selecting material for an item from the works of various persons or bodies (e.g. for an anthology).1899composer:1900ref: csl-person1901description: Composer (e.g. of a musical score).1902container-author:1903ref: csl-person1904description: Author of the container holding the item (e.g. the book author for a book chapter).1905container-title:1906string:1907description:1908short: Title of the container holding the item.1909long: |1910Title of the container holding the item (e.g. the book title for a book chapter,1911the journal title for a journal article; the album title for a recording;1912the session title for multi-part presentation at a conference)1913container-title-short:1914string:1915description: Short/abbreviated form of container-title;1916hidden: true1917contributor:1918ref: csl-person1919description: A minor contributor to the item; typically cited using “with” before the name when listed in a bibliography.1920curator:1921ref: csl-person1922description: Curator of an exhibit or collection (e.g. in a museum).1923dimensions:1924string:1925description: Physical (e.g. size) or temporal (e.g. running time) dimensions of the item.1926director:1927ref: csl-person1928description: Director (e.g. of a film).1929division:1930string:1931description: Minor subdivision of a court with a `jurisdiction` for a legal item1932DOI:1933schema: string1934hidden: true1935edition:1936ref: csl-number1937description: (Container) edition holding the item (e.g. "3" when citing a chapter in the third edition of a book).1938editor:1939ref: csl-person1940description: The editor of the item.1941editorial-director:1942ref: csl-person1943description: Managing editor ("Directeur de la Publication" in French).1944editor-translator:1945ref: csl-person1946description:1947short: Combined editor and translator of a work.1948long: |1949Combined editor and translator of a work.19501951The citation processory must be automatically generate if editor and translator variables1952are identical; May also be provided directly in item data.1953event:1954schema: string1955hidden: true1956event-date:1957ref: csl-date1958description: Date the event related to an item took place.1959event-title:1960string:1961description: Name of the event related to the item (e.g. the conference name when citing a conference paper; the meeting where presentation was made).1962event-place:1963string:1964description: Geographic location of the event related to the item (e.g. "Amsterdam, The Netherlands").1965executive-producer:1966ref: csl-person1967description: Executive producer of the item (e.g. of a television series).1968first-reference-note-number:1969schema:1970ref: csl-number1971description:1972short: Number of a preceding note containing the first reference to the item.1973long: |1974Number of a preceding note containing the first reference to the item19751976Assigned by the CSL processor; Empty in non-note-based styles or when the item hasn't1977been cited in any preceding notes in a document1978hidden: true1979fulltext-url:1980string:1981description: A url to the full text for this item.1982genre:1983string:1984description:1985short: Type, class, or subtype of the item1986long: |1987Type, class, or subtype of the item (e.g. "Doctoral dissertation" for a PhD thesis; "NIH Publication" for an NIH technical report);19881989Do not use for topical descriptions or categories (e.g. "adventure" for an adventure movie)1990guest:1991ref: csl-person1992description: Guest (e.g. on a TV show or podcast).1993host:1994ref: csl-person1995description: Host of the item (e.g. of a TV show or podcast).1996id:1997anyOf:1998- string1999- number2000description: A value which uniquely identifies this item.2001illustrator:2002ref: csl-person2003description: Illustrator (e.g. of a children’s book or graphic novel).2004interviewer:2005ref: csl-person2006description: Interviewer (e.g. of an interview).2007isbn:2008string:2009description: International Standard Book Number (e.g. "978-3-8474-1017-1").2010ISBN:2011schema: string2012hidden: true2013issn:2014string:2015description: International Standard Serial Number.2016ISSN:2017schema: string2018hidden: true2019issue:2020ref: csl-number2021description:2022short: Issue number of the item or container holding the item2023long: |2024Issue number of the item or container holding the item (e.g. "5" when citing a2025journal article from journal volume 2, issue 5);20262027Use `volume-title` for the title of the issue, if any.2028issued:2029ref: csl-date2030description: Date the item was issued/published.2031jurisdiction:2032string:2033description: Geographic scope of relevance (e.g. "US" for a US patent; the court hearing a legal case).2034keyword:2035string:2036description: Keyword(s) or tag(s) attached to the item.2037language:2038string:2039description:2040short: The language of the item (used only for citation of the item).2041long: |2042The language of the item (used only for citation of the item).20432044Should be entered as an ISO 639-1 two-letter language code (e.g. "en", "zh"),2045optionally with a two-letter locale code (e.g. "de-DE", "de-AT").20462047This does not change the language of the item, instead it documents2048what language the item uses (which may be used in citing the item).2049license:2050string:2051description:2052short: The license information applicable to an item.2053long: |2054The license information applicable to an item (e.g. the license an article2055or software is released under; the copyright information for an item;2056the classification status of a document)2057locator:2058ref: csl-number2059description:2060short: A cite-specific pinpointer within the item.2061long: |2062A cite-specific pinpointer within the item (e.g. a page number within a book,2063or a volume in a multi-volume work).20642065Must be accompanied in the input data by a label indicating the locator type2066(see the Locators term list).20672068medium:2069string:2070description: Description of the item’s format or medium (e.g. "CD", "DVD", "Album", etc.)2071narrator:2072ref: csl-person2073description: Narrator (e.g. of an audio book).2074note:2075string:2076description: Descriptive text or notes about an item (e.g. in an annotated bibliography).2077number:2078ref: csl-number2079description: Number identifying the item (e.g. a report number).2080number-of-pages:2081ref: csl-number2082description: Total number of pages of the cited item.2083number-of-volumes:2084ref: csl-number2085description: Total number of volumes, used when citing multi-volume books and such.2086organizer:2087ref: csl-person2088description: Organizer of an event (e.g. organizer of a workshop or conference).2089original-author:2090ref: csl-person2091description:2092short: The original creator of a work.2093long: |2094The original creator of a work (e.g. the form of the author name2095listed on the original version of a book; the historical author of a work;2096the original songwriter or performer for a musical piece; the original2097developer or programmer for a piece of software; the original author of an2098adapted work such as a book adapted into a screenplay)2099original-date:2100ref: csl-date2101description: Issue date of the original version.2102original-publisher:2103string:2104description: Original publisher, for items that have been republished by a different publisher.2105original-publisher-place:2106string:2107description: Geographic location of the original publisher (e.g. "London, UK").2108original-title:2109string:2110description: Title of the original version (e.g. "Война и мир", the untranslated Russian title of "War and Peace").2111page:2112ref: csl-number2113description: Range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).2114page-first:2115ref: csl-number2116description: First page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).2117page-last:2118ref: csl-number2119description: Last page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).2120part-number:2121ref: csl-number2122description:2123short: Number of the specific part of the item being cited (e.g. part 2 of a journal article).2124long: |2125Number of the specific part of the item being cited (e.g. part 2 of a journal article).21262127Use `part-title` for the title of the part, if any.2128part-title:2129string:2130description: Title of the specific part of an item being cited.2131pdf-url:2132string:2133description: A url to the pdf for this item.2134performer:2135ref: csl-person2136description: Performer of an item (e.g. an actor appearing in a film; a muscian performing a piece of music).2137pmcid:2138string:2139description: PubMed Central reference number.2140PMCID:2141schema: string2142hidden: true2143pmid:2144string:2145description: PubMed reference number.2146PMID:2147schema: string2148hidden: true2149printing-number:2150ref: csl-number2151description: Printing number of the item or container holding the item.2152producer:2153ref: csl-person2154description: Producer (e.g. of a television or radio broadcast).2155public-url:2156string:2157description: A public url for this item.2158publisher:2159string:2160description: The publisher of the item.2161publisher-place:2162string:2163description: The geographic location of the publisher.2164recipient:2165ref: csl-person2166description: Recipient (e.g. of a letter).2167reviewed-author:2168ref: csl-person2169description: Author of the item reviewed by the current item.2170reviewed-genre:2171string:2172description: Type of the item being reviewed by the current item (e.g. book, film).2173reviewed-title:2174string:2175description: Title of the item reviewed by the current item.2176scale:2177string:2178description: Scale of e.g. a map or model.2179script-writer:2180ref: csl-person2181description: Writer of a script or screenplay (e.g. of a film).2182section:2183ref: csl-number2184description: Section of the item or container holding the item (e.g. "§2.0.1" for a law; "politics" for a newspaper article).2185series-creator:2186ref: csl-person2187description: Creator of a series (e.g. of a television series).2188source:2189string:2190description: Source from whence the item originates (e.g. a library catalog or database).2191status:2192string:2193description: Publication status of the item (e.g. "forthcoming"; "in press"; "advance online publication"; "retracted")2194submitted:2195ref: csl-date2196description: Date the item (e.g. a manuscript) was submitted for publication.2197supplement-number:2198ref: csl-number2199description: Supplement number of the item or container holding the item (e.g. for secondary legal items that are regularly updated between editions).2200title-short:2201string:2202description: Short/abbreviated form of`title`.2203hidden: true2204translator:2205ref: csl-person2206description: Translator2207type:2208enum:2209[2210"article",2211"article-journal",2212"article-magazine",2213"article-newspaper",2214"bill",2215"book",2216"broadcast",2217"chapter",2218"classic",2219"collection",2220"dataset",2221"document",2222"entry",2223"entry-dictionary",2224"entry-encyclopedia",2225"event",2226"figure",2227"graphic",2228"hearing",2229"interview",2230"legal_case",2231"legislation",2232"manuscript",2233"map",2234"motion_picture",2235"musical_score",2236"pamphlet",2237"paper-conference",2238"patent",2239"performance",2240"periodical",2241"personal_communication",2242"post",2243"post-weblog",2244"regulation",2245"report",2246"review",2247"review-book",2248"software",2249"song",2250"speech",2251"standard",2252"thesis",2253"treaty",2254"webpage",2255]2256description: The [type](https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types) of the item.2257url:2258string:2259description: Uniform Resource Locator (e.g. "https://aem.asm.org/cgi/content/full/74/9/2766")2260URL:2261schema: string2262hidden: true2263version:2264ref: csl-number2265description: Version of the item (e.g. "2.0.9" for a software program).2266volume:2267ref: csl-number2268description:2269short: Volume number of the item (e.g. “2” when citing volume 2 of a book) or the container holding the item.2270long: |2271Volume number of the item (e.g. "2" when citing volume 2 of a book) or the container holding the2272item (e.g. "2" when citing a chapter from volume 2 of a book).22732274Use `volume-title` for the title of the volume, if any.2275volume-title:2276string:2277description:2278short: Title of the volume of the item or container holding the item.2279long: |2280Title of the volume of the item or container holding the item.22812282Also use for titles of periodical special issues, special sections, and the like.2283year-suffix:2284string:2285description: Disambiguating year suffix in author-date styles (e.g. "a" in "Doe, 1999a").22862287- id: csl-item2288object:2289super:2290resolveRef: csl-item-shared2291closed: true2292properties:2293abstract:2294string:2295description: Abstract of the item (e.g. the abstract of a journal article)2296author:2297ref: csl-person2298description: The author(s) of the item.2299doi:2300string:2301description: Digital Object Identifier (e.g. "10.1128/AEM.02591-07")2302references:2303string:2304description:2305short: Resources related to the procedural history of a legal case or legislation.2306long: |2307Resources related to the procedural history of a legal case or legislation;23082309Can also be used to refer to the procedural history of other items (e.g.2310"Conference canceled" for a presentation accepted as a conference that was subsequently2311canceled; details of a retraction or correction notice)2312title:2313string:2314description: The primary title of the item.2315id:2316anyOf:2317- string2318- number2319description: Citation identifier for the item (e.g. "item1"). Will be autogenerated if not provided.23202321- id: citation-item2322object:2323super:2324resolveRef: csl-item2325closed: true2326properties:2327article-id:2328maybeArrayOf:2329anyOf:2330- string2331- object:2332properties:2333type:2334string:2335description: The type of identifier2336value:2337string:2338description: The value for the identifier2339description: The unique identifier for this article.2340elocation-id:2341string:2342description: Bibliographic identifier for a document that does not have traditional printed page numbers.2343eissn:2344string:2345description: Electronic International Standard Serial Number.2346pissn:2347string:2348description: Print International Standard Serial Number.2349art-access-id:2350string:2351description: Generic article accession identifier.2352publisher-location:2353string:2354description: The location of the publisher of this item.2355subject:2356string:2357description: The name of a subject or topic describing the article.2358categories:2359maybeArrayOf:2360string:2361description: A list of subjects or topics describing the article.2362container-id:2363maybeArrayOf:2364anyOf:2365- string2366- object:2367properties:2368type:2369string:2370description: The type of identifier (e.g. `nlm-ta` or `pmc`).2371value:2372string:2373description: The value for the identifier2374description:2375short: External identifier of a publication or journal.2376long: |2377External identifier, typically assigned to a journal by2378a publisher, archive, or library to provide a unique identifier for2379the journal or publication.2380jats-type:2381string:2382description: The type used for the JATS `article` tag.23832384- id: smart-include2385anyOf:2386- record:2387text:2388string:2389description: Textual content to add to includes2390- record:2391file:2392string:2393description: Name of file with content to add to includes23942395- id: semver2396string:2397# from https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string2398pattern: "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"2399description: Version number according to Semantic Versioning24002401- id: quarto-date2402anyOf:2403- string2404- object:2405closed: true2406properties:2407format: string2408value: string2409required: [value]24102411- id: project-profile2412schema:2413object:2414closed: true2415properties:2416default:2417maybeArrayOf: string2418description: |2419Default profile to apply if QUARTO_PROFILE is not defined.2420group:2421maybeArrayOf:2422arrayOf: string2423description: |2424Define a profile group for which at least one profile is always active.2425description: Specify a default profile and profile groups24262427- id: bad-parse-schema2428schema:2429object:2430propertyNames:2431string:2432pattern: "^[^\\s]+$"24332434- id: quarto-dev-schema2435schema:2436object:2437properties:2438_quarto:2439hidden: true2440object:2441properties:2442trace-filters: string2443tests:2444object:2445properties:2446run:2447object:2448description: "Control when tests should run"2449properties:2450ci:2451boolean:2452description: "Run tests on CI (true = run, false = skip)"2453default: true2454skip:2455description: "Skip test unconditionally (true = skip with default message, string = skip with custom message)"2456anyOf:2457- boolean2458- string2459os:2460description: "Run tests ONLY on these platforms (whitelist)"2461anyOf:2462- enum: [linux, darwin, windows]2463- arrayOf:2464enum: [linux, darwin, windows]2465not_os:2466description: "Don't run tests on these platforms (blacklist)"2467anyOf:2468- enum: [linux, darwin, windows]2469- arrayOf:2470enum: [linux, darwin, windows]24712472- id: notebook-view-schema2473schema:2474object:2475properties:2476notebook:2477string:2478description: "The path to the locally referenced notebook."2479title:2480description: "The title of the notebook when viewed."2481anyOf:2482- string2483- boolean2484url:2485string:2486description: "The url to use when viewing this notebook."2487download-url:2488string:2489description: "The url to use when downloading the notebook from the preview"2490required: [notebook]24912492- id: code-links-schema2493schema:2494anyOf:2495- boolean2496- maybeArrayOf:2497anyOf:2498- object:2499properties:2500icon:2501string:2502description: The bootstrap icon for this code link.2503text:2504string:2505description: The text for this code link.2506href:2507string:2508description: The href for this code link.2509rel:2510string:2511description: The rel used in the `a` tag for this code link.2512target:2513string:2514description: The target used in the `a` tag for this code link.2515- enum: ["repo", "binder", "devcontainer"]25162517- id: manuscript-schema2518schema:2519object:2520closed: true2521properties:2522"article":2523path:2524description: "The input document that will serve as the root document for this manuscript"2525"code-links":2526schema:2527ref: code-links-schema2528description: "Code links to display for this manuscript."2529"manuscript-url":2530string:2531description: "The deployed url for this manuscript"2532"meca-bundle":2533anyOf:2534- boolean2535- string2536description: "Whether to generate a MECA bundle for this manuscript"2537"notebooks":2538arrayOf:2539anyOf:2540- string2541- ref: notebook-view-schema2542"resources":2543maybeArrayOf:2544schema: path2545description: "Additional file resources to be copied to output directory"2546"environment":2547maybeArrayOf:2548schema: path2549description: "Files that specify the execution environment (e.g. renv.lock, requirements.text, etc...)"25502551- id: brand-meta2552description: >2553Metadata for a brand, including the brand name and important links.2554object:2555closed: false2556properties:2557name:2558description: The brand name.2559anyOf:2560- string2561- object:2562properties:2563full:2564string:2565description: The full, official or legal name of the company or brand.2566short:2567string:2568description: The short, informal, or common name of the company or brand.2569link:2570description: >2571Important links for the brand, including social media links.2572If a single string, it is the brand's home page or website.2573Additional fields are allowed for internal use.2574anyOf:2575- string2576- object:2577properties:2578home:2579string:2580description: The brand's home page or website.2581mastodon:2582string:2583description: The brand's Mastodon URL.2584bluesky:2585string:2586description: The brand's Bluesky URL.2587github:2588string:2589description: The brand's GitHub URL.2590linkedin:2591string:2592description: The brand's LinkedIn URL.2593twitter:2594string:2595description: The brand's Twitter URL.2596facebook:2597string:2598description: The brand's Facebook URL.25992600- id: brand-string-light-dark2601anyOf:2602- string2603- object:2604closed: true2605properties:2606light:2607schema: string2608description: >2609A link or path to the brand's light-colored logo or icon.2610dark:2611schema: string2612description: >2613A link or path to the brand's dark-colored logo or icon.26142615- id: brand-logo-explicit-resource2616object:2617closed: true2618properties:2619path: path2620alt:2621schema: string2622description: >2623Alternative text for the logo, used for accessibility.2624required: [path]26252626- id: brand-logo-resource2627anyOf:2628- string2629- ref: brand-logo-explicit-resource26302631- id: brand-logo-single2632description: >2633Provide definitions and defaults for brand's logo in various formats and sizes.2634object:2635closed: true2636properties:2637images:2638description: A dictionary of named logo resources.2639schema:2640object:2641additionalProperties:2642schema: { ref: brand-logo-resource }2643small:2644description: >2645A link or path to the brand's small-sized logo or icon.2646schema: string2647medium:2648description: >2649A link or path to the brand's medium-sized logo.2650schema: string2651large:2652description: >2653A link or path to the brand's large- or full-sized logo.2654schema: string26552656- id: brand-logo-unified2657description: >2658Provide definitions and defaults for brand's logo in various formats and sizes.2659object:2660closed: true2661properties:2662images:2663description: A dictionary of named logo resources.2664schema:2665object:2666additionalProperties:2667schema: { ref: brand-logo-resource }2668small:2669description: >2670A link or path to the brand's small-sized logo or icon, or a link or path2671to both the light and dark versions.2672schema:2673ref: brand-string-light-dark2674medium:2675description: >2676A link or path to the brand's medium-sized logo, or a link or path2677to both the light and dark versions.2678schema:2679ref: brand-string-light-dark2680large:2681description: >2682A link or path to the brand's large- or full-sized logo, or a link or path2683to both the light and dark versions.2684schema:2685ref: brand-string-light-dark26862687- id: brand-named-logo2688description: Names of customizeable logos2689enum: [small, medium, large]26902691- id: logo-options2692object:2693closed: false # e.g. to allow typst location, padding, padding-*, width2694properties:2695path:2696schema: path2697description: >2698Path or brand.yml logo resource name.2699alt:2700schema: string2701description: >2702Alternative text for the logo, used for accessibility.2703required: [path]27042705- id: logo-specifier2706anyOf:2707- string2708- schema:2709ref: logo-options27102711- id: logo-options-path-optional2712object:2713closed: false # e.g. to allow typst location, padding, padding-*, width2714properties:2715path:2716schema: path2717description: >2718Path or brand.yml logo resource name.2719alt:2720schema: string2721description: >2722Alternative text for the logo, used for accessibility.27232724- id: logo-specifier-path-optional2725anyOf:2726- string2727- schema:2728ref: logo-options-path-optional27292730- id: logo-light-dark-specifier2731description: >2732Any of the ways a logo can be specified: string, object, or light/dark object of2733string or object. Use `false` to explicitly disable the logo.2734anyOf:2735- enum: [false]2736- ref: logo-specifier2737- object:2738closed: true2739properties:2740light:2741schema:2742ref: logo-specifier2743description: >2744Specification of a light logo2745dark:2746schema:2747ref: logo-specifier2748description: >2749Specification of a dark logo27502751- id: logo-light-dark-specifier-path-optional2752description: >2753Any of the ways a logo can be specified: string, object, or light/dark object of2754string or object. Use `false` to explicitly disable the logo.2755anyOf:2756- enum: [false]2757- ref: logo-specifier-path-optional2758- object:2759closed: true2760properties:2761light:2762schema:2763ref: logo-specifier-path-optional2764description: >2765Specification of a light logo2766dark:2767schema:2768ref: logo-specifier-path-optional2769description: >2770Specification of a dark logo27712772# normalized version of logo-light-dark-specifier2773- id: normalized-logo-light-dark-specifier2774description: >2775Any of the ways a logo can be specified: string, object, or light/dark object of2776string or object2777object:2778closed: true2779properties:2780light:2781schema:2782ref: logo-options2783description: >2784Options for a light logo2785dark:2786schema:2787ref: logo-options2788description: >2789Options for a dark logo27902791- id: brand-color-value2792schema: string27932794- id: brand-color-single2795description: >2796The brand's custom color palette and theme.2797object:2798closed: true2799properties:2800palette:2801description: >2802The brand's custom color palette. Any number of colors can be defined,2803each color having a custom name.2804object:2805additionalProperties:2806schema:2807ref: brand-color-value2808foreground:2809description: The foreground color, used for text.2810schema:2811ref: brand-color-value2812default: black2813background:2814description: The background color, used for the page background.2815schema:2816ref: brand-color-value2817default: white2818primary:2819description: >2820The primary accent color, i.e. the main theme color. Typically used for2821hyperlinks, active states, primary action buttons, etc.2822schema:2823ref: brand-color-value2824secondary:2825description: >2826The secondary accent color. Typically used for lighter text or disabled states.2827schema:2828ref: brand-color-value2829tertiary:2830description: >2831The tertiary accent color. Typically an even lighter color, used for hover states,2832accents, and wells.2833schema:2834ref: brand-color-value2835success:2836description: The color used for positive or successful actions and information.2837schema:2838ref: brand-color-value2839info:2840description: The color used for neutral or informational actions and information.2841schema:2842ref: brand-color-value2843warning:2844description: The color used for warning or cautionary actions and information.2845schema:2846ref: brand-color-value2847danger:2848description: The color used for errors, dangerous actions, or negative information.2849schema:2850ref: brand-color-value2851light:2852description: >2853A bright color, used as a high-contrast foreground color on dark elements2854or low-contrast background color on light elements.2855schema:2856ref: brand-color-value2857dark:2858description: >2859A dark color, used as a high-contrast foreground color on light elements2860or high-contrast background color on light elements.2861schema:2862ref: brand-color-value2863link:2864description: >2865The color used for hyperlinks. If not defined, the `primary` color is used.2866schema:2867ref: brand-color-value28682869- id: brand-color-light-dark2870anyOf:2871- ref: brand-color-value2872- object:2873closed: true2874properties:2875light:2876schema:2877ref: brand-color-value2878description: >2879A link or path to the brand's light-colored logo or icon.2880dark:2881schema:2882ref: brand-color-value2883description: >2884A link or path to the brand's dark-colored logo or icon.28852886- id: brand-color-unified2887description: >2888The brand's custom color palette and theme.2889object:2890closed: true2891properties:2892palette:2893description: >2894The brand's custom color palette. Any number of colors can be defined,2895each color having a custom name.2896object:2897additionalProperties:2898schema:2899ref: brand-color-value2900foreground:2901description: The foreground color, used for text.2902schema:2903ref: brand-color-light-dark2904default: black2905background:2906description: The background color, used for the page background.2907schema:2908ref: brand-color-light-dark2909default: white2910primary:2911description: >2912The primary accent color, i.e. the main theme color. Typically used for2913hyperlinks, active states, primary action buttons, etc.2914schema:2915ref: brand-color-light-dark2916secondary:2917description: >2918The secondary accent color. Typically used for lighter text or disabled states.2919schema:2920ref: brand-color-light-dark2921tertiary:2922description: >2923The tertiary accent color. Typically an even lighter color, used for hover states,2924accents, and wells.2925schema:2926ref: brand-color-light-dark2927success:2928description: The color used for positive or successful actions and information.2929schema:2930ref: brand-color-light-dark2931info:2932description: The color used for neutral or informational actions and information.2933schema:2934ref: brand-color-light-dark2935warning:2936description: The color used for warning or cautionary actions and information.2937schema:2938ref: brand-color-light-dark2939danger:2940description: The color used for errors, dangerous actions, or negative information.2941schema:2942ref: brand-color-light-dark2943light:2944description: >2945A bright color, used as a high-contrast foreground color on dark elements2946or low-contrast background color on light elements.2947schema:2948ref: brand-color-light-dark2949dark:2950description: >2951A dark color, used as a high-contrast foreground color on light elements2952or high-contrast background color on light elements.2953schema:2954ref: brand-color-light-dark2955link:2956description: >2957The color used for hyperlinks. If not defined, the `primary` color is used.2958schema:2959ref: brand-color-light-dark29602961- id: brand-maybe-named-color2962description: >2963A color, which may be a named brand color.2964anyOf:2965- ref: brand-named-theme-color2966- schema: string29672968- id: brand-maybe-named-color-light-dark2969anyOf:2970- ref: brand-maybe-named-color2971- object:2972closed: true2973properties:2974light:2975schema:2976ref: brand-maybe-named-color2977description: >2978A link or path to the brand's light-colored logo or icon.2979dark:2980schema:2981ref: brand-maybe-named-color2982description: >2983A link or path to the brand's dark-colored logo or icon.29842985- id: brand-named-theme-color2986description: >2987A named brand color, taken either from `color.theme` or `color.palette` (in that order).2988enum:2989[2990foreground,2991background,2992primary,2993secondary,2994tertiary,2995success,2996info,2997warning,2998danger,2999light,3000dark,3001link,3002]30033004- id: brand-typography-single3005description: Typography definitions for the brand.3006object:3007closed: true3008properties:3009fonts:3010description: Font files and definitions for the brand.3011arrayOf:3012ref: brand-font3013base:3014description: >3015The base font settings for the brand. These are used as the default for3016all text.3017ref: brand-typography-options-base3018headings:3019description: Settings for headings, or a string specifying the font family only.3020ref: brand-typography-options-headings-single3021monospace:3022description: Settings for monospace text, or a string specifying the font family only.3023ref: brand-typography-options-monospace-single3024monospace-inline:3025description: Settings for inline code, or a string specifying the font family only.3026ref: brand-typography-options-monospace-inline-single3027monospace-block:3028description: Settings for code blocks, or a string specifying the font family only.3029ref: brand-typography-options-monospace-block-single3030link:3031description: Settings for links.3032ref: brand-typography-options-link-single30333034- id: brand-typography-unified3035description: Typography definitions for the brand.3036object:3037closed: true3038properties:3039fonts:3040description: Font files and definitions for the brand.3041arrayOf:3042ref: brand-font3043base:3044description: >3045The base font settings for the brand. These are used as the default for3046all text.3047ref: brand-typography-options-base3048headings:3049description: Settings for headings, or a string specifying the font family only.3050ref: brand-typography-options-headings-unified3051monospace:3052description: Settings for monospace text, or a string specifying the font family only.3053ref: brand-typography-options-monospace-unified3054monospace-inline:3055description: Settings for inline code, or a string specifying the font family only.3056ref: brand-typography-options-monospace-inline-unified3057monospace-block:3058description: Settings for code blocks, or a string specifying the font family only.3059ref: brand-typography-options-monospace-block-unified3060link:3061description: Settings for links.3062ref: brand-typography-options-link-unified30633064- id: brand-typography-options-base3065description: Base typographic options.3066anyOf:3067- string3068- object:3069closed: true3070properties:3071family: string3072size: string3073weight:3074ref: brand-font-weight3075line-height:3076ref: line-height-number-string30773078- id: brand-typography-options-headings-single3079description: Typographic options for headings.3080anyOf:3081- string3082- object:3083closed: true3084properties:3085family: string3086weight:3087ref: brand-font-weight3088style:3089ref: brand-font-style3090color:3091ref: brand-maybe-named-color3092line-height:3093ref: line-height-number-string30943095- id: brand-typography-options-headings-unified3096description: Typographic options for headings.3097anyOf:3098- string3099- object:3100closed: true3101properties:3102family: string3103weight:3104ref: brand-font-weight3105style:3106ref: brand-font-style3107color:3108ref: brand-maybe-named-color-light-dark3109line-height:3110ref: line-height-number-string31113112- id: brand-typography-options-monospace-single3113description: Typographic options for monospace elements.3114anyOf:3115- string3116- object:3117closed: true3118properties:3119family: string3120size: string3121weight:3122ref: brand-font-weight3123color:3124ref: brand-maybe-named-color3125background-color:3126ref: brand-maybe-named-color31273128- id: brand-typography-options-monospace-unified3129description: Typographic options for monospace elements.3130anyOf:3131- string3132- object:3133closed: true3134properties:3135family: string3136size: string3137weight:3138ref: brand-font-weight3139color:3140ref: brand-maybe-named-color-light-dark3141background-color:3142ref: brand-maybe-named-color-light-dark31433144- id: brand-typography-options-monospace-inline-single3145description: Typographic options for inline monospace elements.3146anyOf:3147- string3148- object:3149closed: true3150properties:3151family: string3152size: string3153weight:3154ref: brand-font-weight3155color:3156ref: brand-maybe-named-color3157background-color:3158ref: brand-maybe-named-color31593160- id: brand-typography-options-monospace-inline-unified3161description: Typographic options for inline monospace elements.3162anyOf:3163- string3164- object:3165closed: true3166properties:3167family: string3168size: string3169weight:3170ref: brand-font-weight3171color:3172ref: brand-maybe-named-color-light-dark3173background-color:3174ref: brand-maybe-named-color-light-dark31753176- id: line-height-number-string3177description: Line height3178anyOf: [number, string]31793180- id: brand-typography-options-monospace-block-single3181description: Typographic options for block monospace elements.3182anyOf:3183- string3184- object:3185closed: true3186properties:3187family: string3188size: string3189weight:3190ref: brand-font-weight3191color:3192ref: brand-maybe-named-color3193background-color:3194ref: brand-maybe-named-color3195line-height:3196ref: line-height-number-string31973198- id: brand-typography-options-monospace-block-unified3199description: Typographic options for block monospace elements.3200anyOf:3201- string3202- object:3203closed: true3204properties:3205family: string3206size: string3207weight:3208ref: brand-font-weight3209color:3210ref: brand-maybe-named-color-light-dark3211background-color:3212ref: brand-maybe-named-color-light-dark3213line-height:3214ref: line-height-number-string32153216- id: brand-typography-options-link-single3217description: Typographic options for inline monospace elements.3218anyOf:3219- string3220- object:3221closed: true3222properties:3223weight:3224ref: brand-font-weight3225color:3226ref: brand-maybe-named-color3227background-color:3228ref: brand-maybe-named-color3229decoration: string32303231- id: brand-typography-options-link-unified3232description: Typographic options for inline monospace elements.3233anyOf:3234- string3235- object:3236closed: true3237properties:3238weight:3239ref: brand-font-weight3240color:3241ref: brand-maybe-named-color-light-dark3242background-color:3243ref: brand-maybe-named-color-light-dark3244decoration: string32453246- id: brand-named-typography-elements3247description: Names of customizeable typography elements3248enum: [base, headings, monospace, monospace-inline, monospace-block, link]32493250- id: brand-font3251description: Font files and definitions for the brand.3252anyOf:3253- ref: brand-font-google3254- ref: brand-font-bunny3255- ref: brand-font-file3256- ref: brand-font-system3257# a font definition missing source information,3258# from which we will assume a default source3259#3260# in Quarto, the default source for typst is `google`3261# and the default source for html formats is `bunny`32623263- id: brand-font-weight3264description: A font weight.3265enum:3266[3267100,3268200,3269300,3270400,3271500,3272600,3273700,3274800,3275900,3276thin,3277extra-light,3278ultra-light,3279light,3280normal,3281regular,3282medium,3283semi-bold,3284demi-bold,3285bold,3286extra-bold,3287ultra-bold,3288black,3289]3290default: 40032913292- id: brand-font-style3293description: A font style.3294enum: [normal, italic, oblique]3295default: normal32963297- id: brand-font-common3298schema:3299object:3300closed: true3301properties:3302family:3303description: The font family name, which must match the name of the font on the foundry website.3304schema: string3305weight:3306description: The font weights to include.3307maybeArrayOf:3308ref: brand-font-weight3309default: [400, 700]3310style:3311description: The font styles to include.3312maybeArrayOf:3313ref: brand-font-style3314default: [normal, italic]3315display:3316description: >3317The font display method, determines how a font face is font face is shown3318depending on its download status and readiness for use.3319enum: [auto, block, swap, fallback, optional]3320default: swap33213322- id: brand-font-system3323description: A system font definition.3324object:3325super:3326resolveRef: brand-font-common3327closed: true3328properties:3329source:3330enum: [system]3331required: [source]33323333- id: brand-font-google3334description: A font definition from Google Fonts.3335object:3336super:3337resolveRef: brand-font-common3338closed: true3339properties:3340source:3341enum: [google]3342required: [source]33433344- id: brand-font-bunny3345description: A font definition from fonts.bunny.net.3346object:3347super:3348resolveRef: brand-font-common3349closed: true3350properties:3351source:3352enum: [bunny]3353required: [source]33543355- id: brand-font-file3356description: A method for providing font files directly, either locally or from an online location.3357object:3358closed: true3359properties:3360source:3361enum: [file]3362family:3363description: The font family name.3364schema: string3365files:3366arrayOf:3367anyOf:3368- path3369- schema:3370object:3371properties:3372path:3373schema: path3374description: >3375The path to the font file. This can be a local path or a URL.3376weight:3377ref: brand-font-weight3378style:3379ref: brand-font-style3380required:3381[path]3382# We might want to eventually support these but not on 1.03383#3384# display:3385# description: >3386# The font display method, determines how a font face is font face is shown3387# depending on its download status and readiness for use.3388# enum: [auto, block, swap, fallback, optional]3389# default: swap3390# unicode-range:3391# description: >3392# The range of unicode characters included in the font. Examples:3393# - `U+0025-00FF` includes all characters from `U+0025` to `U+00FF`.3394# - `U+0131,U+0152-0153` includes the characters `U+0131`, `U+0152`, and `U+0153`.3395# schema:3396# string:3397# pattern: '^U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?(?:,U\+[0-9A-F]{4}(?:-[0-9A-F]{4})?)*$'3398description: >3399The font files to include. These can be local or online.3400Local file paths should be relative to the `brand.yml` file.3401Online paths should be complete URLs.3402required: [files, family, source]34033404- id: brand-font-family3405description: >3406A locally-installed font family name. When used, the end-user is responsible3407for ensuring that the font is installed on their system.3408schema: string34093410- id: brand-single3411object:3412closed: true3413properties:3414meta:3415ref: brand-meta3416logo:3417ref: brand-logo-single3418color:3419ref: brand-color-single3420typography:3421ref: brand-typography-single3422defaults:3423ref: brand-defaults34243425- id: brand-unified3426object:3427closed: true3428properties:3429meta:3430ref: brand-meta3431logo:3432ref: brand-logo-unified3433color:3434ref: brand-color-unified3435typography:3436ref: brand-typography-unified3437defaults:3438ref: brand-defaults34393440- id: brand-path-only-light-dark3441anyOf:3442- string3443- object:3444closed: true3445properties:3446light: string3447dark: string3448description: |3449A path to a brand.yml file, or an object with light and dark paths to brand.yml34503451- id: brand-path-bool-light-dark3452anyOf:3453- string # a file path3454- boolean # if false, don't use branding on this document3455- object:3456closed: true3457properties:3458light:3459anyOf:3460- string3461- ref: brand-single3462description: >3463The path to a light brand file or an inline light brand definition.3464dark:3465anyOf:3466- string3467- ref: brand-single3468description: >3469The path to a dark brand file or an inline dark brand definition.3470- ref: brand-unified3471description: |3472Branding information to use for this document. If a string, the path to a brand file.3473If false, don't use branding on this document. If an object, an inline (unified) brand3474definition, or an object with light and dark brand paths or definitions.34753476- id: brand-defaults3477object:3478properties:3479bootstrap:3480ref: brand-defaults-bootstrap3481quarto:3482schema: object34833484- id: brand-defaults-bootstrap3485object:3486properties:3487defaults:3488schema:3489object:3490additionalProperties:3491schema:3492anyOf:3493- string3494- boolean3495- number3496- id: marginalia-side-geometry3497object:3498closed: true3499properties:3500far:3501string:3502description: "Distance from page edge to wideblock boundary."3503width:3504string:3505description: "Width of the margin note column."3506separation:3507string:3508description: "Gap between margin column and body text."35093510# - id: quarto-extension351135123513