/** * Typedoc options declarations. * * @module */ import { DeclarationOption } from 'typedoc'; /** * * ```yaml filename="YAML" * --- * layout: docs * sidebar: true * --- * ``` * * @example {"layout": "docs", "sidebar": true } */ export declare const frontmatterGlobals: Partial; /** * @example {"onReadme": "true" } */ export declare const readmeFrontmatter: Partial; /** * @example {"onIndex": "true" } */ export declare const indexFrontmatter: Partial; /** * Frontmatter variables can be added by extracting comments from block (@) tags. * * Please note tags must be added to the comment blocks of the symbol exported to a page. * * ```ts filename="Block Tags (someModule.ts)" * \/** * * \@author Joe Bloggs * * * * \@description A description that will be added to frontmatter. * *\/ * ``` * * ```yaml filename="YAML (someModule.md)" * --- * author: Joe Bloggs * description: A description that will be added to frontmatter. * --- * ```` * * @example ["author", "description"] */ export declare const frontmatterCommentTags: Partial; /** * By default tags defined in `frontmatterCommentTags` are removed from final output. * * Use this option to preserve the tags in the output. */ export declare const preserveFrontmatterCommentTags: Partial; /** * Block tags have to be written in camelCase (see [tsdoc.org](https://tsdoc.org/pages/spec/tag_kinds)). * * This option can configure the output style of frontmatter variables when written to YAML. */ export declare const frontmatterNamingConvention: Partial; /** * Provides additional options to control how YAML is internally serialized using * the `yaml.stringify` method from the [YAML](https://eemeli.org/yaml/#yaml) library. * * For available options, see * [YAML ToString Options](https://eemeli.org/yaml/#tostring-options). * * Please note that `{ lineWidth: 0 }` is set by default to prevent invalid wrapping. * * @example {"defaultStringType": "QUOTE_SINGLE", "defaultKeyType": "PLAIN"} */ export declare const yamlStringifyOptions: Partial;