schema-types.ts

// This file is automatically generated by `quarto dev-call build-artifacts`! Do not edit.",
//
// If you find yourself trying to rebuild types and `quarto dev-call build-artifacts` won't run because
// of bad type definitions, run the following:
// $ cd $QUARTO_ROOT
// $ ./package/dist/bin/tools/deno run --importmap=./src/import_map.json --allow-all ./package/src/common/create-schema-types.ts ./src/resources

export type MaybeArrayOf<T> = T | T[];
export type JsonObject = { [key: string]: unknown };
// export type SchemaObject = { [key: string]: string };

export type Date = string | { format?: string; value: string };

export type DateFormat = string;

export type MathMethods =
  | "plain"
  | "webtex"
  | "gladtex"
  | "mathml"
  | "mathjax"
  | "katex";

export type PandocFormatRequestHeaders = ((string)[])[];

export type PandocFormatOutputFile = string | null;

export type PandocFormatFilters = ((string | { path: string; type?: string } | {
  at:
    | "pre-ast"
    | "post-ast"
    | "pre-quarto"
    | "post-quarto"
    | "pre-render"
    | "post-render";
  path: string;
  type?: string;
} | { type: "citeproc" }))[];

export type PandocShortcodes = (string)[];

export type PageColumn =
  | "body"
  | "body-outset"
  | "body-outset-left"
  | "body-outset-right"
  | "page"
  | "page-left"
  | "page-right"
  | "page-inset"
  | "page-inset-left"
  | "page-inset-right"
  | "screen"
  | "screen-left"
  | "screen-right"
  | "screen-inset"
  | "screen-inset-shaded"
  | "screen-inset-left"
  | "screen-inset-right"
  | "margin";

export type ContentsAuto = {
  auto?:
    | boolean
    | MaybeArrayOf<
      string
    >; /* Automatically generate sidebar contents. Pass `true` to include all documents
in the site, a directory name to include only documents in that directory,
or a glob (or list of globs) to include documents based on a pattern.

Subdirectories will create sections (use an `index.qmd` in the directory to
provide its title). Order will be alphabetical unless a numeric `order` field
is provided in document metadata. */
};

export type NavigationItem = string | NavigationItemObject;

export type NavigationItemObject = {
  "aria-label"?: string /* Accessible label for the item. */;
  file?: string /* Alias for href */;
  href?: string /* Link to file contained with the project or external URL */;
  icon?: string /* Name of bootstrap icon (e.g. `github`, `bluesky`, `share`)
See <https://icons.getbootstrap.com/> for a list of available icons */;
  id?: string;
  menu?: (NavigationItem)[];
  rel?:
    string /* Value for rel attribute. Multiple space-separated values are permitted.
See <https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel>
for a details. */;
  text?: string /* Text to display for item (defaults to the
document title if not provided) */;
  target?: string /* Value for target attribute.
See <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target>
for details. */;
  url?: string; /* Alias for href */
};

export type GiscusThemes =
  | "light"
  | "light_high_contrast"
  | "light_protanopia"
  | "light_tritanopia"
  | "dark"
  | "dark_high_contrast"
  | "dark_protanopia"
  | "dark_tritanopia"
  | "dark_dimmed"
  | "transparent_dark"
  | "cobalt"
  | "purple_dark"
  | "noborder_light"
  | "noborder_dark"
  | "noborder_gray"
  | "preferred_color_scheme";

export type GiscusConfiguration = {
  "repo-id"?: string /* The Github repository identifier.

You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
If this is not provided, Quarto will attempt to discover it at render time. */;
  "category-id"?: string /* The Github category identifier.

You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
If this is not provided, Quarto will attempt to discover it at render time. */;
  "reactions-enabled"?:
    boolean /* Display reactions for the discussion's main post before the comments. */;
  "input-position"?:
    | "top"
    | "bottom" /* Place the comment input box above or below the comments. */;
  category?:
    string /* The discussion category where new discussions will be created. It is recommended
to use a category with the **Announcements** type so that new discussions
can only be created by maintainers and giscus. */;
  loading?: "lazy";
  language?:
    string /* The language that should be used when displaying the commenting interface. */;
  mapping?: string | number;
  repo: string /* The Github repo that will be used to store comments.

In order to work correctly, the repo must be public, with the giscus app installed, and
the discussions feature must be enabled. */;
  theme?: string | GiscusThemes | {
    dark?: string | GiscusThemes /* The dark theme name. */;
    light?: string | GiscusThemes; /* The light theme name. */
  }; /* The 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:

```yaml
website:
  comments:
    giscus:
      theme:
        light: light # giscus theme used for light website theme
        dark: dark_dimmed # giscus theme used for dark website theme
``` */
};

export type ExternalEngine = {
  path: string; /* Path to the TypeScript module for the execution engine */
}; /* An execution engine not pre-loaded in Quarto */

export type DocumentCommentsConfiguration = false | {
  giscus?: GiscusConfiguration;
  hypothesis?: boolean | {
    "client-url"?:
      string /* Override the default hypothesis client url with a custom client url. */;
    assetRoot?: string /* The root URL from which assets are loaded. */;
    branding?: {
      accentColor?:
        string /* Secondary color for elements of the commenting UI. */;
      appBackgroundColor?:
        string /* The main background color of the commenting UI. */;
      annotationFontFamily?:
        string /* The font family for the actual annotation value that the user writes about the page or selection. */;
      ctaBackgroundColor?:
        string /* The background color for call to action buttons. */;
      selectionFontFamily?:
        string; /* The font family for selection text in the annotation card. */
    } /* Settings to adjust the commenting sidebar's look and feel. */;
    enableExperimentalNewNoteButton?:
      boolean /* Controls whether the experimental New Note button
should be shown in the notes tab in the sidebar. */;
    externalContainerSelector?:
      string /* A CSS selector specifying the containing element into which the sidebar iframe will be placed. */;
    focus?: {
      user: {
        displayName?: string /* The display name of the user to focus on. */;
        username?: string /* The username of the user to focus on. */;
        userid?: string; /* The userid of the user to focus on. */
      };
    } /* Defines a focused filter set for the available annotations on a page. */;
    openSidebar?:
      boolean /* Controls whether the sidebar opens automatically on startup. */;
    requestConfigFromFrame?: {
      ancestorLevel?:
        number /* Number of nested iframes deep the client is relative from the receiving iframe. */;
      origin?: string; /* Host url and port number of receiving iframe */
    };
    showHighlights?:
      | boolean
      | (
        | "always"
        | "whenSidebarOpen"
        | "never"
      ) /* Controls whether the in-document highlights are shown by default (`always`, `whenSidebarOpen` or `never`) */;
    services?: (
      {
        apiUrl: string /* The base URL of the service API. */;
        authority:
          string /* The domain name which the annotation service is associated with. */;
        allowLeavingGroups?:
          boolean /* A flag indicating whether users should be able to leave groups of which they are a member. */;
        enableShareLinks?:
          boolean /* A flag indicating whether annotation cards should show links that take the user to see an annotation in context. */;
        grantToken:
          string /* 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. */;
        groups?:
          | "$rpc:requestGroups"
          | (string)[] /* An array of Group IDs or the literal string `$rpc:requestGroups` */;
        icon?:
          string; /* The URL to an image for the annotation service. This image will appear to the left of the name of the currently selected group. */
      } /* Alternative annotation services which the client should
connect to instead of connecting to the public Hypothesis
service at hypothes.is. */
    )[] /* Alternative annotation services which the client should
connect to instead of connecting to the public Hypothesis
service at hypothes.is. */;
    sidebarAppUrl?:
      string /* The URL for the sidebar application which displays annotations. */;
    theme?:
      | "classic"
      | "clean" /* Controls the overall look of the sidebar (`classic` or `clean`) */;
    usernameUrl?: string;
  };
  utterances?: {
    "issue-term"?: string /* How posts should be mapped to Github issues
(`pathname`, `url`, `title` or `og:title`) */;
    label?:
      string /* The label that will be assigned to issues created by Utterances. */;
    repo: string /* The Github repo that will be used to store comments. */;
    theme?: string; /* The Github theme that should be used for Utterances
(`github-light`, `github-dark`, `github-dark-orange`,
`icy-dark`, `dark-blue`, `photon-dark`, `body-light`,
or `gruvbox-dark`) */
  };
};

export type SocialMetadata = {
  "image-alt"?:
    string /* The alt text for the preview image. By default, Quarto will use
the `image-alt` value from the format metadata. If you provide an
image, you may also optionally provide an `image-width` and `image-height`. */;
  "image-width"?: number /* Image width (pixels) */;
  "image-height"?: number /* Image height (pixels) */;
  description?:
    string /* A short description of the content. Note that by default Quarto will
automatically  use the description metadata from the page. Specify this
field if you’d like to override the description for this provider. */;
  image?:
    string /* The path to a preview image for the content. By default, Quarto will use
the `image` value from the format metadata. If you provide an
image, you may also optionally provide an `image-width` and `image-height`. */;
  title?:
    string; /* The title of the page. Note that by default Quarto will automatically
use the title metadata from the page. Specify this field if you’d like
to override the title for this provider. */
};

export type PageFooterRegion = string | (NavigationItem)[];

export type SidebarContents =
  | string
  | ContentsAuto
  | ((NavigationItem | string | {
    contents?: SidebarContents;
    section?: string | null;
  } | ContentsAuto))[];

export type ProjectPreview = {
  "watch-inputs"?:
    boolean /* Re-render input files when they change (defaults to true) */;
  browser?:
    boolean /* Open a web browser to view the preview (defaults to true) */;
  host?: string /* Hostname to bind to (defaults to 127.0.0.1) */;
  navigate?:
    boolean /* Navigate the browser automatically when outputs are updated (defaults to true) */;
  port?:
    number /* Port to listen on (defaults to random value between 3000 and 8000) */;
  serve?: ProjectServe;
  timeout?:
    number; /* Time (in seconds) after which to exit if there are no active clients */
};

export type ProjectServe = {
  args?: string /* Additional command line arguments for preview command. */;
  cmd: string /* Serve project preview using the specified command.
Interpolate the `--port` into the command using `{port}`. */;
  env?: JsonObject /* Environment variables to set for preview command. */;
  ready:
    string; /* Regular expression for detecting when the server is ready. */
};

export type Publish = {
  netlify?: (PublishRecord)[];
}; /* Sites published to Netlify */

export type PublishRecord = {
  id?: string /* Unique identifier for site */;
  url?: string; /* Published URL for site */
};

export type TwitterCardConfig = {
  "card-style"?:
    | "summary"
    | "summary_large_image" /* Card style (`summary` or `summary_large_image`).

If this is not provided, the best style will automatically
selected based upon other metadata. You can learn more about Twitter Card
styles [here](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards). */;
  creator?:
    string /* `@username` of the content creator (must be a quoted string) */;
  site?: string; /* `@username` of the website (must be a quoted string) */
} & SocialMetadata;

export type OpenGraphConfig = {
  "site-name"?:
    string /* Name that should be displayed for the overall site. If not explicitly
provided in the `open-graph` metadata, Quarto will use the website or
book `title` by default. */;
  locale?: string; /* Locale of open graph metadata */
} & SocialMetadata;

export type PageFooter = {
  border?:
    | boolean
    | string /* Footer border (`true`, `false`, or a border color) */;
  background?: string;
  center?: PageFooterRegion;
  foreground?: string;
  left?: PageFooterRegion;
  right?: PageFooterRegion;
};

export type BaseWebsite = {
  "site-url"?: string /* Base URL for published website */;
  "site-path"?:
    string /* Path to site (defaults to `/`). Not required if you specify `site-url`. */;
  "repo-url"?: string /* Base URL for website source code repository */;
  "repo-link-target"?:
    string /* The value of the target attribute for repo links */;
  "repo-link-rel"?: string /* The value of the rel attribute for repo links */;
  "repo-subdir"?: string /* Subdirectory of repository containing website */;
  "repo-branch"?:
    string /* Branch of website source code (defaults to `main`) */;
  "issue-url"?:
    string /* URL to use for the 'report an issue' repository action. */;
  "repo-actions"?: MaybeArrayOf<
    (
      | "none"
      | "edit"
      | "source"
      | "issue"
    ) /* Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`) */
  > /* Links to source repository actions (`none` or one or more of `edit`, `source`, `issue`) */;
  "reader-mode"?:
    boolean /* Displays a 'reader-mode' tool which allows users to hide the sidebar and table of contents when viewing a page. */;
  "google-analytics"?: string | {
    "tracking-id"?: string;
    "anonymize-ip"?: boolean;
    storage?:
      | "cookies"
      | "none" /* Storage option for Google Analytics data using on of these two values:

`cookies`: Use cookies to store unique user and session identification (default).

`none`: Do not use cookies to store unique user and session identification.

For more about choosing storage options see [Storage](https://quarto.org/docs/websites/website-tools.html#storage). */;
    version?: 3 | 4; /* The version number of Google Analytics to use.

- `3`: Use analytics.js
- `4`: use gtag.

This is automatically detected based upon the `tracking-id`, but you may specify it. */
  } /* Enable Google Analytics for this website */;
  "plausible-analytics"?: string | {
    path:
      string; /* Path to a file containing the Plausible Analytics script snippet */
  } /* Enable Plausible Analytics for this website by pasting the script snippet from your Plausible dashboard,
or by providing a path to a file containing the snippet.

Plausible is a privacy-friendly, GDPR-compliant web analytics service that does not use cookies and does not require cookie consent.

**Option 1: Inline snippet**

```yaml
website:
  plausible-analytics: |
    <script async src="https://plausible.io/js/script.js"></script>
```

**Option 2: File path**

```yaml
website:
  plausible-analytics:
    path: _plausible_snippet.html
```

To get your script snippet:

1. Log into your Plausible account at <https://plausible.io>
2. Go to your site settings
3. Copy the JavaScript snippet provided
4. Either paste it directly in your configuration or save it to a file

For more information, see <https://plausible.io/docs/plausible-script> */;
  "cookie-consent"?: ("express" | "implied") | boolean | {
    "policy-url"?: string;
    "prefs-text"?: string;
    language?: string;
    palette?:
      | "light"
      | "dark" /* Whether to use a dark or light appearance for the consent banner (`light` or `dark`). */;
    style?:
      | "simple"
      | "headline"
      | "interstitial"
      | "standalone" /* The style of the consent banner that is displayed:

- `simple` (default): A simple dialog in the lower right corner of the website.

- `headline`: A full width banner across the top of the website.

- `interstitial`: An semi-transparent overlay of the entire website.

- `standalone`: An opaque overlay of the entire website. */;
    type?:
      | "express"
      | "implied"; /* The type of consent that should be requested, using one of these two values:

- `express` (default): This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn’t agree).

- `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. */
  } /* Quarto includes the ability to request cookie consent before enabling scripts that set cookies, using [Cookie Consent](https://www.cookieconsent.com/).

The 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). */;
  "body-header"?:
    string /* Markdown to insert at the beginning of each page’s body (below the title and author block). */;
  "body-footer"?: string /* Markdown to insert below each page’s body. */;
  "margin-header"?: MaybeArrayOf<
    string
  > /* Markdown to place above margin content (text or file path) */;
  "margin-footer"?: MaybeArrayOf<
    string
  > /* Markdown to place below margin content (text or file path) */;
  "page-navigation"?:
    boolean /* Provide next and previous article links in footer */;
  "back-to-top-navigation"?:
    boolean /* Provide a 'back to top' navigation button */;
  "bread-crumbs"?:
    boolean /* Whether to show navigation breadcrumbs for pages more than 1 level deep */;
  "page-footer"?: string | PageFooter /* Shared page footer */;
  "image-alt"?:
    string /* Default site thumbnail image alt text for `twitter` /`open-graph` */;
  "open-graph"?: boolean | OpenGraphConfig /* Publish open graph metadata */;
  "twitter-card"?:
    | boolean
    | TwitterCardConfig /* Publish twitter card metadata */;
  "other-links"?: OtherLinks;
  "code-links"?: boolean | CodeLinksSchema;
  "draft-mode"?: "visible" | "unlinked" | "gone";
  announcement?: string | {
    content?: string;
    dismissable?: boolean;
    icon?: string;
    position?: "above-navbar" | "below-navbar";
    type?:
      | "primary"
      | "secondary"
      | "success"
      | "danger"
      | "warning"
      | "info"
      | "light"
      | "dark";
  } /* Provides an announcement displayed at the top of the page. */;
  comments?: DocumentCommentsConfiguration;
  description?: string /* Website description */;
  drafts?: MaybeArrayOf<string>;
  favicon?: string /* The path to the favicon for this website */;
  image?: string /* Default site thumbnail image for `twitter` /`open-graph` */;
  navbar?: boolean | {
    "logo-alt"?: string /* Alternate text for the logo image. */;
    "logo-href"?:
      string /* Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html). */;
    "collapse-below"?:
      | "sm"
      | "md"
      | "lg"
      | "xl"
      | "xxl" /* The responsive breakpoint below which the navbar will collapse into a menu (`sm`, `md`, `lg` (default), `xl`, `xxl`). */;
    "toggle-position"?: "left" | "right";
    "tools-collapse"?:
      boolean /* Collapse tools into the navbar menu when the display becomes narrow. */;
    background?:
      string /* The navbar's background color (named or hex color). */;
    collapse?:
      boolean /* Collapse the navbar into a menu when the display becomes narrow. */;
    foreground?:
      string /* The navbar's foreground color (named or hex color). */;
    logo?: LogoLightDarkSpecifier;
    left?:
      (NavigationItem)[] /* List of items for the left side of the navbar. */;
    pinned?: boolean /* Always show the navbar (keeping it pinned). */;
    right?:
      (NavigationItem)[] /* List of items for the right side of the navbar. */;
    search?: boolean /* Include a search box in the navbar. */;
    title?:
      | string
      | boolean; /* The navbar title. Uses the project title if none is specified. */
  } /* Top navigation options */;
  search?: boolean | {
    "collapse-after"?: number;
    "copy-button"?: boolean;
    "merge-navbar-crumbs"?: boolean;
    "keyboard-shortcut"?: MaybeArrayOf<
      string /* One or more keys that will act as a shortcut to launch search (single characters) */
    >;
    "show-item-context"?: ("tree" | "parent" | "root") | boolean;
    algolia?: {
      "index-name"?: string;
      "application-id"?: string;
      "search-only-api-key"?: string;
      "analytics-events"?:
        boolean /* Enable tracking of Algolia analytics events */;
      "show-logo"?:
        boolean /* Enable the display of the Algolia logo in the search results footer. */;
      "index-fields"?: {
        href?: string;
        section?: string;
        title?: string;
        text?: string;
      };
      params?:
        JsonObject; /* Additional parameters to pass when executing a search */
    } /* Use external Algolia search index */;
    location?:
      | "navbar"
      | "sidebar" /* Location for search widget (`navbar` or `sidebar`) */;
    limit?: number;
    type?:
      | "overlay"
      | "textbox"; /* Type of search UI (`overlay` or `textbox`) */
  } /* Provide full text search for website */;
  sidebar?:
    | boolean
    | MaybeArrayOf<
      {
        "logo-alt"?: string /* Alternate text for the logo image. */;
        "logo-href"?:
          string /* Target href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html). */;
        "collapse-level"?:
          number /* The depth at which the sidebar contents should be collapsed by default. */;
        alignment?:
          | "left"
          | "right"
          | "center" /* Alignment of the items within the sidebar (`left`, `right`, or `center`) */;
        background?: string;
        border?:
          boolean /* Whether to show a border on the sidebar (defaults to true for 'docked' sidebars) */;
        contents?: SidebarContents;
        foreground?: string;
        footer?: MaybeArrayOf<
          string
        > /* Markdown to place below sidebar content (text or file path) */;
        header?: MaybeArrayOf<
          string
        > /* Markdown to place above sidebar content (text or file path) */;
        id?: string /* The identifier for this sidebar. */;
        logo?: LogoLightDarkSpecifier;
        pinned?:
          boolean /* When collapsed, pin the collapsed sidebar to the top of the page. */;
        search?: boolean /* Include a search control in the sidebar. */;
        style?:
          | "docked"
          | "floating" /* The style of sidebar (`docked` or `floating`). */;
        title?:
          | string
          | boolean /* The sidebar title. Uses the project title if none is specified. */;
        tools?: (NavigationItemObject)[]; /* List of sidebar tools */
      }
    > /* Side navigation options */;
  title?: string; /* Website title */
};

export type BookSchema = {
  "date-format"?: string /* Format string for dates in the book */;
  "output-file"?:
    string /* Base name for single-file output (e.g. PDF, ePub, docx) */;
  "cover-image"?: string /* Cover image (used in HTML and ePub formats) */;
  "cover-image-alt"?:
    string /* Alternative text for cover image (used in HTML format) */;
  author?: MaybeArrayOf<
    (string | JsonObject) /* Author or authors of the book */
  > /* Author or authors of the book */;
  abstract?: string /* Book abstract */;
  appendices?: ChapterList;
  chapters?: ChapterList;
  date?: string /* Book publication date */;
  description?: string /* Description metadata for HTML version of book */;
  downloads?: MaybeArrayOf<
    (
      | "pdf"
      | "epub"
      | "docx"
    ) /* Download buttons for other formats to include on navbar or sidebar
(one or more of `pdf`, `epub`, and `docx`) */
  > /* Download buttons for other formats to include on navbar or sidebar
(one or more of `pdf`, `epub`, and `docx`) */;
  doi?: string /* The Digital Object Identifier for this book. */;
  references?: string /* Book references file */;
  subtitle?: string /* Book subtitle */;
  sharing?: MaybeArrayOf<
    (
      | "twitter"
      | "facebook"
      | "linkedin"
    ) /* Sharing buttons to include on navbar or sidebar
(one or more of `twitter`, `facebook`, `linkedin`) */
  > /* Sharing buttons to include on navbar or sidebar
(one or more of `twitter`, `facebook`, `linkedin`) */;
  title?: string /* Book title */;
  tools?: (NavigationItem)[]; /* Custom tools for navbar or sidebar */
} & BaseWebsite;

export type ChapterItem = NavigationItem | {
  chapters?: (NavigationItem)[] /* Path to chapter input file */;
  part: string; /* Part title or path to input file */
};

export type ChapterList = (ChapterItem)[];

export type OtherLinks = ({
  href: string /* The href for the link. */;
  icon?: string /* The bootstrap icon name for the link. */;
  rel?: string /* The rel attribute value for the link. */;
  text: string /* The text for the link. */;
  target?: string; /* The target attribute value for the link. */
})[];

export type CrossrefLabelsSchema = string;

export type EpubContributor =
  | string
  | MaybeArrayOf<
    {
      "file-as"?:
        string /* An alternate version of the creator or contributor text used for alphabatizing. */;
      role?: string /* The role of this creator or contributor using
[MARC relators](https://loc.gov/marc/relators/relaterm.html). Human readable
translations to commonly used relators (e.g. 'author', 'editor') will
attempt to be automatically translated. */;
      text?:
        string; /* The text describing the creator or contributor (for example, creator name). */
    }
  >;

export type FormatLanguage = {
  "toc-title-document"?: string;
  "toc-title-website"?: string;
  "related-formats-title"?: string;
  "related-notebooks-title"?: string;
  "callout-tip-title"?: string;
  "callout-note-title"?: string;
  "callout-warning-title"?: string;
  "callout-important-title"?: string;
  "callout-caution-title"?: string;
  "section-title-abstract"?: string;
  "section-title-footnotes"?: string;
  "section-title-appendices"?: string;
  "code-summary"?: string;
  "code-tools-menu-caption"?: string;
  "code-tools-show-all-code"?: string;
  "code-tools-hide-all-code"?: string;
  "code-tools-show-all-sections"?: string;
  "code-tools-hide-all-sections"?: string;
  "code-tools-view-source"?: string;
  "code-tools-source-code"?: string;
  "search-no-results-text"?: string;
  "copy-button-tooltip"?: string;
  "copy-button-tooltip-success"?: string;
  "repo-action-links-edit"?: string;
  "repo-action-links-source"?: string;
  "repo-action-links-issue"?: string;
  "search-matching-documents-text"?: string;
  "search-copy-link-title"?: string;
  "search-hide-matches-text"?: string;
  "search-more-match-text"?: string;
  "search-more-matches-text"?: string;
  "search-clear-button-title"?: string;
  "search-text-placeholder"?: string;
  "search-detached-cancel-button-title"?: string;
  "search-submit-button-title"?: string;
  "crossref-fig-title"?: string;
  "crossref-tbl-title"?: string;
  "crossref-lst-title"?: string;
  "crossref-thm-title"?: string;
  "crossref-lem-title"?: string;
  "crossref-cor-title"?: string;
  "crossref-prp-title"?: string;
  "crossref-cnj-title"?: string;
  "crossref-def-title"?: string;
  "crossref-exm-title"?: string;
  "crossref-exr-title"?: string;
  "crossref-fig-prefix"?: string;
  "crossref-tbl-prefix"?: string;
  "crossref-lst-prefix"?: string;
  "crossref-ch-prefix"?: string;
  "crossref-apx-prefix"?: string;
  "crossref-sec-prefix"?: string;
  "crossref-eq-prefix"?: string;
  "crossref-thm-prefix"?: string;
  "crossref-lem-prefix"?: string;
  "crossref-cor-prefix"?: string;
  "crossref-prp-prefix"?: string;
  "crossref-cnj-prefix"?: string;
  "crossref-def-prefix"?: string;
  "crossref-exm-prefix"?: string;
  "crossref-exr-prefix"?: string;
  "crossref-lof-title"?: string;
  "crossref-lot-title"?: string;
  "crossref-lol-title"?: string;
};

export type WebsiteAbout = {
  "image-alt"?: string /* The alt text for the main image on the about page. */;
  "image-title"?: string /* The title for the main image on the about page. */;
  "image-width"?: string /* A valid CSS width for the about page image. */;
  "image-shape"?:
    | "rectangle"
    | "round"
    | "rounded" /* The shape of the image on the about page.

- `rectangle`
- `round`
- `rounded` */;
  id?:
    string /* The target id of this about page. When the about page is rendered, it will
place read the contents of a `div` with this id into the about template that you
have selected (and replace the contents with the rendered about content).

If no such `div` is defined on the page, a `div` with this id will be created
and appended to the end of the page. */;
  image?:
    string /* The path to the main image on the about page. If not specified,
the `image` provided for the document itself will be used. */;
  links?: (NavigationItem)[];
  template:
    | ("jolla" | "trestles" | "solana" | "marquee" | "broadside")
    | string; /* The template to use to layout this about page. Choose from:

- `jolla`
- `trestles`
- `solana`
- `marquee`
- `broadside` */
};

export type WebsiteListing = {
  "max-items"?:
    number /* The maximum number of items to include in this listing. */;
  "page-size"?: number /* The number of items to display on a page. */;
  "sort-ui"?:
    | boolean
    | (string)[] /* Shows or hides the sorting control for the listing. To control the
fields that will be displayed in the sorting control, provide a list
of field names. */;
  "filter-ui"?:
    | boolean
    | (string)[] /* Shows or hides the filtering control for the listing. To control the
fields that will be used to filter the listing, provide a list
of field names. By default all fields of the listing will be used
when filtering. */;
  "date-format"?:
    string /* The date format to use when displaying dates (e.g. d-M-yyy).
Learn more about supported date formatting values [here](https://quarto.org/docs/reference/dates.html). */;
  "max-description-length"?:
    number /* The maximum length (in characters) of the description displayed in the listing.
Defaults to 175. */;
  "image-placeholder"?:
    string /* The default image to use if an item in the listing doesn't have an image. */;
  "image-lazy-loading"?:
    boolean /* If false, images in the listing will be loaded immediately. If true, images will be loaded as they come into view. */;
  "image-align"?:
    | "left"
    | "right" /* In `default` type listings, whether to place the image on the right or left side of the post content (`left` or `right`). */;
  "image-height"?:
    string /* The height of the image being displayed (a CSS height string).

The width is automatically determined and the image will fill the rectangle without scaling (cropped to fill). */;
  "grid-columns"?:
    number /* In grid type listings, the number of columns in the grid display.
Defaults to 3. */;
  "grid-item-border"?:
    boolean /* In grid type listings, whether to display a border around the item card. Defaults to `true`. */;
  "grid-item-align"?:
    | "left"
    | "right"
    | "center" /* In grid type listings, the alignment of the content within the card (`left` (default), `right`, or `center`). */;
  "table-striped"?:
    boolean /* In table type listings, display the table rows with alternating background colors.
Defaults to `false`. */;
  "table-hover"?:
    boolean /* In table type listings, highlight rows of the table when the user hovers the mouse over them.
Defaults to false. */;
  "template-params"?: JsonObject;
  "field-display-names"?:
    JsonObject /* A mapping that provides display names for specific fields. For example, to display the title column as ‘Report’ in a table listing you would write:

```yaml
listing:
  field-display-names:
  title: "Report"
``` */;
  "field-types"?:
    JsonObject /* Provides the date type for the field of a listing item. Unknown fields are treated
as strings unless a type is provided. Valid types are `date`, `number`. */;
  "field-links"?:
    (string)[] /* The list of fields to display as hyperlinks to the source document
when the listing type is a table. By default, only the `title` or
`filename` is displayed as a link. */;
  "field-required"?:
    (string)[] /* Fields that items in this listing must have populated.
If a listing is rendered and one more items in this listing
is missing a required field, an error will occur and the render will. */;
  contents?: MaybeArrayOf<
    (string | WebsiteListingContentsObject)
  > /* The files or path globs of Quarto documents or YAML files that should be included in the listing. */;
  categories?:
    | boolean
    | (
      | "numbered"
      | "unnumbered"
      | "cloud"
    ) /* Display item categories from this listing in the margin of the page.

  - `numbered`: Category list with number of items
  - `unnumbered`: Category list
  - `cloud`: Word cloud style categories */;
  exclude?: MaybeArrayOf<
    JsonObject
  > /* Items with matching field values will be excluded from the listing. */;
  feed?: boolean | {
    "xml-stylesheet"?:
      string /* The path to an XML stylesheet (XSL file) used to style the RSS feed. */;
    categories?: MaybeArrayOf<
      string /* A list of categories for which to create separate RSS feeds containing only posts with that category */
    >;
    description?:
      string /* The description of this feed. If not specified, the description for the page the
listing appears on will be used, otherwise the description
of the site will be used if specified in the Quarto project. */;
    items?:
      number /* The number of items to include in your feed. Defaults to 20. */;
    image?:
      string /* The path to an image for this feed. If not specified, the image for the page the listing
appears on will be used, otherwise an image will be used if specified for the site
in the Quarto project. */;
    language?: string /* The language of the feed. Omitted if not specified.
See [https://www.rssboard.org/rss-language-codes](https://www.rssboard.org/rss-language-codes)
for a list of valid language codes. */;
    type?:
      | "full"
      | "partial"
      | "metadata" /* Whether to include full or partial content in the feed.

- `full` (default): Include the complete content of the document in the feed.
- `partial`: Include only the first paragraph of the document in the feed.
- `metadata`: Use only the title, description, and other document metadata in the feed. */;
    title?:
      string; /* The title for this feed. Defaults to the site title provided the Quarto project. */
  } /* Enables an RSS feed for the listing. */;
  fields?: (string)[] /* The list of fields to include in this listing. */;
  id?: string /* The id of this listing. When the listing is rendered, it will
place the contents into a `div` with this id. If no such `div` is defined on the
page, a `div` with this id will be created and appended to the end of the page.

If no `id` is provided for a listing, Quarto will synthesize one when rendering the page. */;
  include?: MaybeArrayOf<
    JsonObject
  > /* Items with matching field values will be included in the listing. */;
  sort?:
    | boolean
    | MaybeArrayOf<
      string
    > /* Sort items in the listing by these fields. The sort key is made up of a
field name followed by a direction `asc` or `desc`.

For example:
`date asc`

Use `sort:false` to use the unsorted original order of items. */;
  type?:
    | "default"
    | "table"
    | "grid"
    | "custom" /* The type of listing to create. Choose one of:

- `default`: A blog style list of items
- `table`: A table of items
- `grid`: A grid of item cards
- `custom`: A custom template, provided by the `template` field */;
  template?: string; /* The path to a custom listing template. */
};

export type WebsiteListingContentsObject = {
  author?: MaybeArrayOf<string>;
  date?: string;
  subtitle?: string;
  title?: string;
};

export type CslDate = string | MaybeArrayOf<number> | {
  day?: number /* The day */;
  month?: number /* The month */;
  year?: number; /* The year */
};

export type CslPerson =
  | MaybeArrayOf<string>
  | MaybeArrayOf<
    {
      "family-name"?: string /* The family name. */;
      "given-name"?: string; /* The given name. */
    }
  >;

export type CslNumber = number | string;

export type CslItemShared = {
  "abstract-url"?: string /* A url to the abstract for this item. */;
  "archive-collection"?:
    string /* Collection the item is part of within an archive. */;
  "archive-location"?:
    string /* Storage location within an archive (e.g. a box and folder number). */;
  "archive-place"?: string /* Geographic location of the archive. */;
  "available-date"?: CslDate;
  "call-number"?: string /* Call number (to locate the item in a library). */;
  "chapter-number"?: CslNumber;
  "citation-key"?:
    string /* Identifier of the item in the input data file (analogous to BiTeX entrykey);

Use this variable to facilitate conversion between word-processor and plain-text writing systems;
For an identifer intended as formatted output label for a citation
(e.g. “Ferr78”), use `citation-label` instead */;
  "citation-label"?:
    string /* Label identifying the item in in-text citations of label styles (e.g. "Ferr78");

May be assigned by the CSL processor based on item metadata; For the identifier of the item
in the input data file, use `citation-key` instead */;
  "citation-number"?: CslNumber;
  "collection-editor"?: CslPerson;
  "collection-number"?: CslNumber;
  "collection-title"?:
    string /* Title of the collection holding the item (e.g. the series title for a book; the lecture series title for a presentation). */;
  "container-author"?: CslPerson;
  "container-title"?:
    string /* Title of the container holding the item (e.g. the book title for a book chapter,
the journal title for a journal article; the album title for a recording;
the session title for multi-part presentation at a conference) */;
  "container-title-short"?:
    string /* Short/abbreviated form of container-title; */;
  "editorial-director"?: CslPerson;
  "editor-translator"?: CslPerson;
  "event-date"?: CslDate;
  "event-title"?:
    string /* Name of the event related to the item (e.g. the conference name when citing a conference paper; the meeting where presentation was made). */;
  "event-place"?:
    string /* Geographic location of the event related to the item (e.g. "Amsterdam, The Netherlands"). */;
  "executive-producer"?: CslPerson;
  "first-reference-note-number"?: CslNumber;
  "fulltext-url"?: string /* A url to the full text for this item. */;
  "number-of-pages"?: CslNumber;
  "number-of-volumes"?: CslNumber;
  "original-author"?: CslPerson;
  "original-date"?: CslDate;
  "original-publisher"?:
    string /* Original publisher, for items that have been republished by a different publisher. */;
  "original-publisher-place"?:
    string /* Geographic location of the original publisher (e.g. "London, UK"). */;
  "original-title"?:
    string /* Title of the original version (e.g. "Война и мир", the untranslated Russian title of "War and Peace"). */;
  "page-first"?: CslNumber;
  "page-last"?: CslNumber;
  "part-number"?: CslNumber;
  "part-title"?:
    string /* Title of the specific part of an item being cited. */;
  "pdf-url"?: string /* A url to the pdf for this item. */;
  "printing-number"?: CslNumber;
  "public-url"?: string /* A public url for this item. */;
  "publisher-place"?: string /* The geographic location of the publisher. */;
  "reviewed-author"?: CslPerson;
  "reviewed-genre"?:
    string /* Type of the item being reviewed by the current item (e.g. book, film). */;
  "reviewed-title"?:
    string /* Title of the item reviewed by the current item. */;
  "script-writer"?: CslPerson;
  "series-creator"?: CslPerson;
  "supplement-number"?: CslNumber;
  "title-short"?: string /* Short/abbreviated form of`title`. */;
  "volume-title"?:
    string /* Title of the volume of the item or container holding the item.

Also use for titles of periodical special issues, special sections, and the like. */;
  "year-suffix"?:
    string /* Disambiguating year suffix in author-date styles (e.g. "a" in "Doe, 1999a"). */;
  accessed?: CslDate;
  annote?:
    string /* Short markup, decoration, or annotation to the item (e.g., to indicate items included in a review);

For descriptive text (e.g., in an annotated bibliography), use `note` instead */;
  archive?: string /* Archive storing the item */;
  archive_collection?: string;
  archive_location?: string;
  authority?:
    string /* Issuing or judicial authority (e.g. "USPTO" for a patent, "Fairfax Circuit Court" for a legal case). */;
  chair?: CslPerson;
  compiler?: CslPerson;
  composer?: CslPerson;
  contributor?: CslPerson;
  curator?: CslPerson;
  dimensions?:
    string /* Physical (e.g. size) or temporal (e.g. running time) dimensions of the item. */;
  director?: CslPerson;
  division?:
    string /* Minor subdivision of a court with a `jurisdiction` for a legal item */;
  DOI?: string;
  edition?: CslNumber;
  editor?: CslPerson;
  event?: string;
  genre?:
    string /* Type, class, or subtype of the item (e.g. "Doctoral dissertation" for a PhD thesis; "NIH Publication" for an NIH technical report);

Do not use for topical descriptions or categories (e.g. "adventure" for an adventure movie) */;
  guest?: CslPerson;
  host?: CslPerson;
  id?: string | number /* A value which uniquely identifies this item. */;
  illustrator?: CslPerson;
  interviewer?: CslPerson;
  isbn?:
    string /* International Standard Book Number (e.g. "978-3-8474-1017-1"). */;
  issn?: string /* International Standard Serial Number. */;
  issue?: CslNumber;
  issued?: CslDate;
  ISBN?: string;
  ISSN?: string;
  jurisdiction?:
    string /* Geographic scope of relevance (e.g. "US" for a US patent; the court hearing a legal case). */;
  keyword?: string /* Keyword(s) or tag(s) attached to the item. */;
  language?:
    string /* The language of the item (used only for citation of the item).

Should be entered as an ISO 639-1 two-letter language code (e.g. "en", "zh"),
optionally with a two-letter locale code (e.g. "de-DE", "de-AT").

This does not change the language of the item, instead it documents
what language the item uses (which may be used in citing the item). */;
  license?:
    string /* The license information applicable to an item (e.g. the license an article
or software is released under; the copyright information for an item;
the classification status of a document) */;
  locator?: CslNumber;
  medium?:
    string /* Description of the item’s format or medium (e.g. "CD", "DVD", "Album", etc.) */;
  narrator?: CslPerson;
  note?:
    string /* Descriptive text or notes about an item (e.g. in an annotated bibliography). */;
  number?: CslNumber;
  organizer?: CslPerson;
  page?: CslNumber;
  performer?: CslPerson;
  pmcid?: string /* PubMed Central reference number. */;
  pmid?: string /* PubMed reference number. */;
  producer?: CslPerson;
  publisher?: string /* The publisher of the item. */;
  PMCID?: string;
  PMID?: string;
  recipient?: CslPerson;
  scale?: string /* Scale of e.g. a map or model. */;
  section?: CslNumber;
  source?:
    string /* Source from whence the item originates (e.g. a library catalog or database). */;
  status?:
    string /* Publication status of the item (e.g. "forthcoming"; "in press"; "advance online publication"; "retracted") */;
  submitted?: CslDate;
  translator?: CslPerson;
  type?:
    | "article"
    | "article-journal"
    | "article-magazine"
    | "article-newspaper"
    | "bill"
    | "book"
    | "broadcast"
    | "chapter"
    | "classic"
    | "collection"
    | "dataset"
    | "document"
    | "entry"
    | "entry-dictionary"
    | "entry-encyclopedia"
    | "event"
    | "figure"
    | "graphic"
    | "hearing"
    | "interview"
    | "legal_case"
    | "legislation"
    | "manuscript"
    | "map"
    | "motion_picture"
    | "musical_score"
    | "pamphlet"
    | "paper-conference"
    | "patent"
    | "performance"
    | "periodical"
    | "personal_communication"
    | "post"
    | "post-weblog"
    | "regulation"
    | "report"
    | "review"
    | "review-book"
    | "software"
    | "song"
    | "speech"
    | "standard"
    | "thesis"
    | "treaty"
    | "webpage" /* The [type](https://docs.citationstyles.org/en/stable/specification.html#appendix-iii-types) of the item. */;
  url?:
    string /* Uniform Resource Locator (e.g. "https://aem.asm.org/cgi/content/full/74/9/2766") */;
  URL?: string;
  version?: CslNumber;
  volume?: CslNumber;
};

export type CslItem = {
  abstract?:
    string /* Abstract of the item (e.g. the abstract of a journal article) */;
  author?: CslPerson;
  doi?: string /* Digital Object Identifier (e.g. "10.1128/AEM.02591-07") */;
  id?:
    | string
    | number /* Citation identifier for the item (e.g. "item1"). Will be autogenerated if not provided. */;
  references?:
    string /* Resources related to the procedural history of a legal case or legislation;

Can also be used to refer to the procedural history of other items (e.g.
"Conference canceled" for a presentation accepted as a conference that was subsequently
canceled; details of a retraction or correction notice) */;
  title?: string; /* The primary title of the item. */
} & CslItemShared;

export type CitationItem = {
  "article-id"?: MaybeArrayOf<
    (string | {
      type?: string /* The type of identifier */;
      value?: string; /* The value for the identifier */
    })
  > /* The unique identifier for this article. */;
  "elocation-id"?:
    string /* Bibliographic identifier for a document that does not have traditional printed page numbers. */;
  "art-access-id"?: string /* Generic article accession identifier. */;
  "publisher-location"?:
    string /* The location of the publisher of this item. */;
  "container-id"?: MaybeArrayOf<
    (string | {
      type?: string /* The type of identifier (e.g. `nlm-ta` or `pmc`). */;
      value?: string; /* The value for the identifier */
    })
  > /* External identifier, typically assigned to a journal by
a publisher, archive, or library to provide a unique identifier for
the journal or publication. */;
  "jats-type"?: string /* The type used for the JATS `article` tag. */;
  categories?: MaybeArrayOf<
    string /* A list of subjects or topics describing the article. */
  >;
  eissn?: string /* Electronic International Standard Serial Number. */;
  pissn?: string /* Print International Standard Serial Number. */;
  subject?: string; /* The name of a subject or topic describing the article. */
} & CslItem;

export type SmartInclude = {
  text: string; /* Textual content to add to includes */
} | { file: string /* Name of file with content to add to includes */ };

export type Semver =
  string; /* Version number according to Semantic Versioning */

export type QuartoDate = string | { format?: string; value: string };

export type ProjectProfile = {
  default?: MaybeArrayOf<
    string
  > /* Default profile to apply if QUARTO_PROFILE is not defined. */;
  group?: MaybeArrayOf<
    (string)[]
  >; /* Define a profile group for which at least one profile is always active. */
};

export type BadParseSchema = JsonObject;

export type QuartoDevSchema = {
  _quarto?: {
    "trace-filters"?: string;
    tests?: {
      run?: {
        ci?: boolean /* Run tests on CI (true = run, false = skip) */;
        not_os?:
          | ("linux" | "darwin" | "windows")
          | ((
            | "linux"
            | "darwin"
            | "windows"
          ))[] /* Don't run tests on these platforms (blacklist) */;
        os?:
          | ("linux" | "darwin" | "windows")
          | ((
            | "linux"
            | "darwin"
            | "windows"
          ))[] /* Run tests ONLY on these platforms (whitelist) */;
        skip?:
          | boolean
          | string; /* Skip test unconditionally (true = skip with default message, string = skip with custom message) */
      }; /* Control when tests should run */
    };
  };
};

export type NotebookViewSchema = {
  "download-url"?:
    string /* The url to use when downloading the notebook from the preview */;
  notebook: string /* The path to the locally referenced notebook. */;
  title?: string | boolean /* The title of the notebook when viewed. */;
  url?: string; /* The url to use when viewing this notebook. */
};

export type CodeLinksSchema =
  | boolean
  | MaybeArrayOf<
    ({
      href?: string /* The href for this code link. */;
      icon?: string /* The bootstrap icon for this code link. */;
      rel?: string /* The rel used in the `a` tag for this code link. */;
      text?: string /* The text for this code link. */;
      target?: string; /* The target used in the `a` tag for this code link. */
    } | ("repo" | "binder" | "devcontainer"))
  >;

export type ManuscriptSchema = {
  "code-links"?: CodeLinksSchema;
  "manuscript-url"?: string /* The deployed url for this manuscript */;
  "meca-bundle"?:
    | boolean
    | string /* Whether to generate a MECA bundle for this manuscript */;
  article?:
    string /* The input document that will serve as the root document for this manuscript */;
  environment?: MaybeArrayOf<
    string
  > /* Files that specify the execution environment (e.g. renv.lock, requirements.text, etc...) */;
  notebooks?: ((string | NotebookViewSchema))[];
  resources?: MaybeArrayOf<
    string
  >; /* Additional file resources to be copied to output directory */
};

export type BrandMeta = {
  link?: string | {
    bluesky?: string /* The brand's Bluesky URL. */;
    facebook?: string /* The brand's Facebook URL. */;
    github?: string /* The brand's GitHub URL. */;
    home?: string /* The brand's home page or website. */;
    linkedin?: string /* The brand's LinkedIn URL. */;
    mastodon?: string /* The brand's Mastodon URL. */;
    twitter?: string; /* The brand's Twitter URL. */
  } /* Important links for the brand, including social media links. If a single string, it is the brand's home page or website. Additional fields are allowed for internal use. */;
  name?: string | {
    full?:
      string /* The full, official or legal name of the company or brand. */;
    short?:
      string; /* The short, informal, or common name of the company or brand. */
  }; /* The brand name. */
}; /* Metadata for a brand, including the brand name and important links. */

export type BrandStringLightDark = string | { dark?: string; light?: string };

export type BrandLogoExplicitResource = { alt?: string; path: string };

export type BrandLogoResource = string | BrandLogoExplicitResource;

export type BrandLogoSingle = {
  images?: { [key: string]: BrandLogoResource };
  large?: string;
  medium?: string;
  small?: string;
}; /* Provide definitions and defaults for brand's logo in various formats and sizes. */

export type BrandLogoUnified = {
  images?: { [key: string]: BrandLogoResource };
  large?: BrandStringLightDark;
  medium?: BrandStringLightDark;
  small?: BrandStringLightDark;
}; /* Provide definitions and defaults for brand's logo in various formats and sizes. */

export type BrandNamedLogo =
  | "small"
  | "medium"
  | "large"; /* Names of customizeable logos */

export type LogoOptions = { alt?: string; path: string };

export type LogoSpecifier = string | LogoOptions;

export type LogoOptionsPathOptional = { alt?: string; path?: string };

export type LogoSpecifierPathOptional = string | LogoOptionsPathOptional;

export type LogoLightDarkSpecifier = false | LogoSpecifier | {
  dark?: LogoSpecifier;
  light?: LogoSpecifier;
}; /* Any of the ways a logo can be specified: string, object, or light/dark object of string or object. Use `false` to explicitly disable the logo. */

export type LogoLightDarkSpecifierPathOptional = LogoSpecifierPathOptional | {
  dark?: LogoSpecifierPathOptional;
  light?: LogoSpecifierPathOptional;
}; /* Any of the ways a logo can be specified: string, object, or light/dark object of string or object */

export type NormalizedLogoLightDarkSpecifier = {
  dark?: LogoOptions;
  light?: LogoOptions;
}; /* Any of the ways a logo can be specified: string, object, or light/dark object of string or object */

export type BrandColorValue = string;

export type BrandColorSingle = {
  background?: BrandColorValue;
  danger?: BrandColorValue;
  dark?: BrandColorValue;
  foreground?: BrandColorValue;
  info?: BrandColorValue;
  light?: BrandColorValue;
  link?: BrandColorValue;
  palette?: {
    [key: string]: BrandColorValue;
  } /* The brand's custom color palette. Any number of colors can be defined, each color having a custom name. */;
  primary?: BrandColorValue;
  secondary?: BrandColorValue;
  success?: BrandColorValue;
  tertiary?: BrandColorValue;
  warning?: BrandColorValue;
}; /* The brand's custom color palette and theme. */

export type BrandColorLightDark = BrandColorValue | {
  dark?: BrandColorValue;
  light?: BrandColorValue;
};

export type BrandColorUnified = {
  background?: BrandColorLightDark;
  danger?: BrandColorLightDark;
  dark?: BrandColorLightDark;
  foreground?: BrandColorLightDark;
  info?: BrandColorLightDark;
  light?: BrandColorLightDark;
  link?: BrandColorLightDark;
  palette?: {
    [key: string]: BrandColorValue;
  } /* The brand's custom color palette. Any number of colors can be defined, each color having a custom name. */;
  primary?: BrandColorLightDark;
  secondary?: BrandColorLightDark;
  success?: BrandColorLightDark;
  tertiary?: BrandColorLightDark;
  warning?: BrandColorLightDark;
}; /* The brand's custom color palette and theme. */

export type BrandMaybeNamedColor =
  | BrandNamedThemeColor
  | string; /* A color, which may be a named brand color. */

export type BrandMaybeNamedColorLightDark = BrandMaybeNamedColor | {
  dark?: BrandMaybeNamedColor;
  light?: BrandMaybeNamedColor;
};

export type BrandNamedThemeColor =
  | "foreground"
  | "background"
  | "primary"
  | "secondary"
  | "tertiary"
  | "success"
  | "info"
  | "warning"
  | "danger"
  | "light"
  | "dark"
  | "link"; /* A named brand color, taken either from `color.theme` or `color.palette` (in that order). */

export type BrandTypographySingle = {
  "monospace-inline"?: BrandTypographyOptionsMonospaceInlineSingle;
  "monospace-block"?: BrandTypographyOptionsMonospaceBlockSingle;
  base?: BrandTypographyOptionsBase;
  fonts?: (BrandFont)[] /* Font files and definitions for the brand. */;
  headings?: BrandTypographyOptionsHeadingsSingle;
  link?: BrandTypographyOptionsLinkSingle;
  monospace?: BrandTypographyOptionsMonospaceSingle;
}; /* Typography definitions for the brand. */

export type BrandTypographyUnified = {
  "monospace-inline"?: BrandTypographyOptionsMonospaceInlineUnified;
  "monospace-block"?: BrandTypographyOptionsMonospaceBlockUnified;
  base?: BrandTypographyOptionsBase;
  fonts?: (BrandFont)[] /* Font files and definitions for the brand. */;
  headings?: BrandTypographyOptionsHeadingsUnified;
  link?: BrandTypographyOptionsLinkUnified;
  monospace?: BrandTypographyOptionsMonospaceUnified;
}; /* Typography definitions for the brand. */

export type BrandTypographyOptionsBase = string | {
  "line-height"?: LineHeightNumberString;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Base typographic options. */

export type BrandTypographyOptionsHeadingsSingle = string | {
  "line-height"?: LineHeightNumberString;
  color?: BrandMaybeNamedColor;
  family?: string;
  style?: BrandFontStyle;
  weight?: BrandFontWeight;
}; /* Typographic options for headings. */

export type BrandTypographyOptionsHeadingsUnified = string | {
  "line-height"?: LineHeightNumberString;
  color?: BrandMaybeNamedColorLightDark;
  family?: string;
  style?: BrandFontStyle;
  weight?: BrandFontWeight;
}; /* Typographic options for headings. */

export type BrandTypographyOptionsMonospaceSingle = string | {
  "background-color"?: BrandMaybeNamedColor;
  color?: BrandMaybeNamedColor;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for monospace elements. */

export type BrandTypographyOptionsMonospaceUnified = string | {
  "background-color"?: BrandMaybeNamedColorLightDark;
  color?: BrandMaybeNamedColorLightDark;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for monospace elements. */

export type BrandTypographyOptionsMonospaceInlineSingle = string | {
  "background-color"?: BrandMaybeNamedColor;
  color?: BrandMaybeNamedColor;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for inline monospace elements. */

export type BrandTypographyOptionsMonospaceInlineUnified = string | {
  "background-color"?: BrandMaybeNamedColorLightDark;
  color?: BrandMaybeNamedColorLightDark;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for inline monospace elements. */

export type LineHeightNumberString = number | string; /* Line height */

export type BrandTypographyOptionsMonospaceBlockSingle = string | {
  "background-color"?: BrandMaybeNamedColor;
  "line-height"?: LineHeightNumberString;
  color?: BrandMaybeNamedColor;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for block monospace elements. */

export type BrandTypographyOptionsMonospaceBlockUnified = string | {
  "background-color"?: BrandMaybeNamedColorLightDark;
  "line-height"?: LineHeightNumberString;
  color?: BrandMaybeNamedColorLightDark;
  family?: string;
  size?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for block monospace elements. */

export type BrandTypographyOptionsLinkSingle = string | {
  "background-color"?: BrandMaybeNamedColor;
  color?: BrandMaybeNamedColor;
  decoration?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for inline monospace elements. */

export type BrandTypographyOptionsLinkUnified = string | {
  "background-color"?: BrandMaybeNamedColorLightDark;
  color?: BrandMaybeNamedColorLightDark;
  decoration?: string;
  weight?: BrandFontWeight;
}; /* Typographic options for inline monospace elements. */

export type BrandNamedTypographyElements =
  | "base"
  | "headings"
  | "monospace"
  | "monospace-inline"
  | "monospace-block"
  | "link"; /* Names of customizeable typography elements */

export type BrandFont =
  | BrandFontGoogle
  | BrandFontBunny
  | BrandFontFile
  | BrandFontSystem; /* Font files and definitions for the brand. */

export type BrandFontWeight =
  | 100
  | 200
  | 300
  | 400
  | 500
  | 600
  | 700
  | 800
  | 900
  | "thin"
  | "extra-light"
  | "ultra-light"
  | "light"
  | "normal"
  | "regular"
  | "medium"
  | "semi-bold"
  | "demi-bold"
  | "bold"
  | "extra-bold"
  | "ultra-bold"
  | "black"; /* A font weight. */

export type BrandFontStyle =
  | "normal"
  | "italic"
  | "oblique"; /* A font style. */

export type BrandFontCommon = {
  display?:
    | "auto"
    | "block"
    | "swap"
    | "fallback"
    | "optional" /* The font display method, determines how a font face is font face is shown depending on its download status and readiness for use. */;
  family?: string;
  style?: MaybeArrayOf<BrandFontStyle> /* The font styles to include. */;
  weight?: MaybeArrayOf<BrandFontWeight>; /* The font weights to include. */
};

export type BrandFontSystem =
  & { source: "system" }
  & BrandFontCommon; /* A system font definition. */

export type BrandFontGoogle =
  & { source: "google" }
  & BrandFontCommon; /* A font definition from Google Fonts. */

export type BrandFontBunny =
  & { source: "bunny" }
  & BrandFontCommon; /* A font definition from fonts.bunny.net. */

export type BrandFontFile = {
  family: string;
  files: ((string | {
    path: string;
    style?: BrandFontStyle;
    weight?: BrandFontWeight;
  }))[] /* The font files to include. These can be local or online. Local file paths should be relative to the `brand.yml` file. Online paths should be complete URLs. */;
  source: "file";
}; /* A method for providing font files directly, either locally or from an online location. */

export type BrandFontFamily = string;

export type BrandSingle = {
  color?: BrandColorSingle;
  defaults?: BrandDefaults;
  logo?: BrandLogoSingle;
  meta?: BrandMeta;
  typography?: BrandTypographySingle;
};

export type BrandUnified = {
  color?: BrandColorUnified;
  defaults?: BrandDefaults;
  logo?: BrandLogoUnified;
  meta?: BrandMeta;
  typography?: BrandTypographyUnified;
};

export type BrandPathOnlyLightDark = string | {
  dark?: string;
  light?: string;
}; /* A path to a brand.yml file, or an object with light and dark paths to brand.yml */

export type BrandPathBoolLightDark =
  | string
  | boolean
  | {
    dark?:
      | string
      | BrandSingle /* The path to a dark brand file or an inline dark brand definition. */;
    light?:
      | string
      | BrandSingle; /* The path to a light brand file or an inline light brand definition. */
  }
  | BrandUnified; /* Branding information to use for this document. If a string, the path to a brand file.
If false, don't use branding on this document. If an object, an inline (unified) brand
definition, or an object with light and dark brand paths or definitions. */

export type BrandDefaults = {
  bootstrap?: BrandDefaultsBootstrap;
  quarto?: JsonObject;
};

export type BrandDefaultsBootstrap = {
  defaults?: { [key: string]: string | boolean | number };
};

export type MarginaliaSideGeometry = {
  far?: string /* Distance from page edge to wideblock boundary. */;
  separation?: string /* Gap between margin column and body text. */;
  width?: string; /* Width of the margin note column. */
};

export type ProjectConfig = {
  "execute-dir"?:
    | "file"
    | "project" /* Control the working directory for computations.

- `file`: Use the directory of the file that is currently executing.
- `project`: Use the root directory of the project. */;
  "output-dir"?: string /* Output directory */;
  "lib-dir"?: string /* HTML library (JS/CSS/etc.) directory */;
  "pre-render"?: MaybeArrayOf<string>;
  "post-render"?: MaybeArrayOf<string>;
  brand?: BrandPathOnlyLightDark;
  detect?: ((string)[])[];
  preview?: ProjectPreview;
  render?: (string)[] /* Files to render (defaults to all files) */;
  resources?: MaybeArrayOf<
    string
  > /* Additional file resources to be copied to output directory */;
  title?: string;
  type?:
    string; /* Project type (`default`, `website`, `book`, or `manuscript`) */
};

export type BookProject = JsonObject;