Select theme

Guides
- Commands
API reference
- build
- bundlers
  - esbuild-impl
    change-extension-plugin
    Overview
    changeExtensionPlugin
    rewriteImportPathExtensions
    custom-esbuild-options-plugin
    Overview
    customEsbuildOptionsPlugin
    fix-esm-plugin
    Overview
    fixEsmPlugin
    preprocess-plugin
    Overview
    ensureBrowserProcess
    ensureDisposeSymbols
    keepName
    makePreprocessBanner
    MakePreprocessBannerOptions
    preprocessPlugin
    PreprocessPluginOptions
    svelte-wrapper-plugin
    Overview
    isMissingSveltePackageError
    svelteWrapperPlugin
- check-project-types
- cli-utils
- code-generator
  - Overview
  - generate
- commitlint-config
- commitlint-forbidden-patterns
- commitlint-spellcheck-header
- docs-site
  - api-doc-constants
    Overview
    EVENT_METHODS
    GENERIC_TYPE_PARAMS
    TS_GLOBAL_TYPES
    TS_PRIMITIVE_TYPES
    TS_UTILITY_TYPES
  - api-doc-documented-files
    Overview
    isDocumentedDirectoryName
    isDocumentedFileName
    isDocumentedModulePath
  - api-doc-jsdoc
    Overview
    extractClassInfo
    extractConstructorInfo
    extractEnumInfo
    extractFileOverview
    extractInterfaceInfo
    extractMethodInfo
    extractMethodSignatureInfo
    extractPropertyInfo
    extractPropertySignatureInfo
    extractTypeAliasInfo
    getDeclaredReturnType
    getDescription
    getExamples
    getParameterDescriptions
    getPropertyType
    getRemarks
    getReturnDescription
    getSince
    resolveTypeofAliases
  - api-doc-link-rendering
    Overview
    doesMemberPageExist
    findType
    linkBaseType
    loadExternalTypeMaps
    markdownToHtml
    memberHref
    registerMemberPages
    registerRouteSegments
    renderExampleMdx
    renderMdxProse
    renderTypeWithLinks
    resolveExternalTypeUrl
    resolveLinks
    resolveTsUtilityUrl
    resolveWebApiUrl
    toTypeFileSegment
    toTypeRouteSegment
    typeHref
    typeLink
  - api-doc-package-sites
    Overview
    clearPackageDeclarations
    DEFAULT_PACKAGE_SITES
    getPackageTypeUrl
    registerPackageDeclaration
  - api-doc-page-generation
    Overview
    appendBacklinksAndWrite
    buildBacklinksFromContent
    buildSidebarTree
    computeOverviewSignature
    generateMemberPages
    generateNamespaceIndexPages
    generateOverviewPage
    generateSidebarJson
    renderConstructorMdx
    renderEnumPage
    renderFrontMatter
    renderFunctionPage
    renderMethodOverloadMdx
    renderMethodTableMdx
    renderPropertyTableMdx
    renderTypeAliasPage
    renderVariablePage
    sidebarTreeToEntries
  - api-doc-route-segments
    Overview
    toRouteSegment
    toRouteSegmentPreserveCase
  - api-doc-settings
    Overview
    ApiDocSettings
    configureApiDocs
    getApiDocSettings
  - api-doc-source-processing
    Overview
    collectFunctions
    collectPackageDeclarations
    collectVariables
    computeCacheHash
    computeNamespace
    findEntryFiles
    processSourceFile
    registerGenericTypeParams
  - api-doc-text-utils
    Overview
    computeOverloadKey
    ensureDirectory
    escapeJsString
    escapeJsxAttribute
    escapeMarkdown
    escapeMdxAngleBrackets
    escapeMdxBraces
    escapeMdxProse
    escapeYaml
    foldTsDocParagraphs
    getDisplayName
    getImportStatement
    getNamespaceDirectory
    memberRouteSegment
    memberSlug
    overloadRouteSegment
    overloadSlug
    replaceRegExpMatches
    segmentMarkdown
    simplifyType
    stripMarkdown
    truncateSignature
  - api-doc-type-merging
    Overview
    buildTypeParameterMap
    parseTypeArguments
    resolveInheritedMembers
    substituteMemberTypes
    substituteTypeParams
  - api-doc-types
    Overview
    CodeSegment
    EnumMemberInfo
    MarkdownSegment
    MemberInfo
    PageContent
    PageFrontMatter
    ParameterInfo
    ProseSegment
    ReturnTypeProvider
    SidebarEntry
    SidebarLink
    SidebarTreeNode
    TextProvider
    TypeInfo
    WebApiEntry
  - api-docs
    Overview
    generateApiDocs
    GenerateApiDocsParams
  - astro-config
    Overview
    defineDocsSiteConfig
  - docs-links
    Overview
    assertDocsLinksResolve
    AssertDocsLinksResolveParams
  - docs-site-assets
    Overview
    API_COMPONENTS_IMPORT_PREFIX
    getDocsSiteAssetsDirectory
  - docs-site-commands
    Overview
    buildDocsSite
    devDocsSite
    previewDocsSite
  - docs-site-config
    Overview
    DocsSiteConfig
    ResolvedDocsSiteConfig
    resolveDocsSiteConfig
  - docs-snippets
    Overview
    assertDocsSnippetsCompile
    AssertDocsSnippetsCompileParams
    DocsSnippet
    DocsSnippetProblem
    extractDocsSnippets
    findDocsSnippetProblems
    FindDocsSnippetProblemsParams
    formatDocsSnippetProblems
  - link-check
    Overview
    BrokenLink
    collectBrokenExternalLinks
    CollectBrokenExternalLinksOptions
    collectBrokenLinks
    collectExternalTargets
    DEFAULT_EXTERNAL_LINK_PER_HOST_CONCURRENCY
    DEFAULT_EXTERNAL_LINK_RETRY_INITIAL_DELAY_IN_MILLISECONDS
    DEFAULT_EXTERNAL_LINK_RETRY_MAX_DELAY_IN_MILLISECONDS
    DEFAULT_EXTERNAL_LINK_RETRY_TOTAL_BUDGET_IN_MILLISECONDS
    DocumentationPage
    ExternalLinkProbeResult
    ExternalLinkRetryOptions
    extractIds
    extractLinks
    formatBrokenLinks
    getOutputRelativePath
    getPageUrl
    isInternalDocUrl
    LinkCheckFileSystem
    NETWORK_FAILURE_STATUS
    parseRetryAfterInMilliseconds
    resolveWithinRoot
  - og-image
    Overview
    computeOgHash
    loadFonts
    loadLogoDataUri
    OgCardContent
    renderOgImage
    RenderOgImageOptions
  - og-image-page
    Overview
    getOgImagePageSlug
  - og-images
    Overview
    generateOgImages
    GenerateOgImagesParams
  - outdated-references
    Overview
    assertNoOutdatedReferences
    findOutdatedReferences
    findOutdatedReferencesInText
    formatOutdatedReferences
    OUTDATED_REFERENCE_ALLOW_MARKER
    OutdatedReference
  - repo-homepage
    Overview
    RepoHomepageMode
    syncRepoHomepage
    SyncRepoHomepageParams
  - route-data
    Overview
    onRequest
  - satteri-github-alerts
    Overview
    GITHUB_ALERT_ASIDE_VARIANTS
    satteriGitHubAlerts
  - satteri-relative-links
    Overview
    satteriRelativeLinks
  - unrendered-alerts
    Overview
    collectUnrenderedAlerts
    formatUnrenderedAlerts
    UnrenderedAlert
- env-toggle
- exec
- forbidden-patterns
- formatters
- fs
- gate
- git
- json
- library-build
- linters
  - auto
    Overview
    detectLinter
    lint
    Linter
    LintOptions
  - biome
    Overview
    lint
    LintOptions
  - cspell
    Overview
    spellcheck
    SpellcheckOptions
  - cspell-content
    Overview
    spellcheckContent
    SpellcheckContentParams
  - eslint
    Overview
    classifyEslintExit
    describeFailureToLint
    EslintExitKind
    hasEslintConfig
    lint
    LINT_PROBLEMS_MESSAGE
    LintOptions
  - eslint-agnostic-core-boundary
    Overview
    getPackageBoundaryNoRestrictedImportPatterns
    GetPackageBoundaryNoRestrictedImportPatternsParams
    NoRestrictedImportPatternEntry
  - eslint-config
    Overview
    createDefaultEslintConfigContext
    defineEslintConfigs
    DefineEslintConfigsOptions
    EslintConfigContext
    getEslintCoreConfigs
    getGlobalIgnoreConfigs
    getTypeScriptEslintConfigs
    GetTypeScriptEslintConfigsParams
  - eslint-no-restricted-syntax
    Overview
    noRestrictedSyntaxRuleEntries
    NoRestrictedSyntaxRuleEntry
  - eslint-rules
    in-house-plugin
    Overview
    genericInHouseEslintRules
    IN_HOUSE_ESLINT_PLUGIN_NAME
    inHouseEslintPlugin
    no-async-callback-to-unsafe-return
    Overview
    MESSAGE_ID
    noAsyncCallbackToUnsafeReturn
    no-unresolved-jsdoc-link
    Overview
    MESSAGE_ID
    noUnresolvedJsdocLink
    no-unused-params-members
    Overview
    MESSAGE_ID
    noUnusedParamsMembers
    no-used-underscore-variables
    Overview
    MESSAGE_ID
    noUsedUnderscoreVariables
    params-options-name-match
    Overview
    MESSAGE_ID
    paramsOptionsNameMatch
    prefer-logical-operator-over-ternary
    Overview
    MESSAGE_ID
    preferLogicalOperatorOverTernary
    UNICORN_RULE_NAME
    prefer-noop-async
    Overview
    MESSAGE_ID
    preferNoopAsync
    readonly-params-options-result-members
    Overview
    MESSAGE_ID
    readonlyParamsOptionsResultMembers
    require-method-template
    Overview
    MESSAGE_ID_MISSING_TEMPLATE
    MESSAGE_ID_MISSING_TEMPLATE_DESCRIPTION
    requireMethodTemplate
    require-super-call
    Overview
    MESSAGE_ID
    requireSuperCall
    rule-tester-helper
    Overview
    toRuleTesterModule
    ts-estree-node
    Overview
    toTSESTreeNode
  - lint-ignores
    Overview
    CLAUDE_WORKTREES_IGNORE_GLOB
  - markdownlint
    Overview
    lint
    LintOptions
  - markdownlint-cli2-config
    Overview
    obsidianDevUtilsConfig
  - markdownlint-content
    Overview
    lintMarkdownContent
    LintMarkdownContentParams
  - markdownlint-ignores
    Overview
    checkIsInNodeModules
    NODE_MODULES_IGNORE_GLOB
  - markdownlint-rules
    no-soft-break-in-paragraph
    Overview
    NO_SOFT_BREAK_IN_PARAGRAPH_RULE_NAME
    noSoftBreakInParagraphRule
  - over-exposure
    Overview
    analyzeOverExposure
    AnalyzeOverExposureParams
    createLanguageServiceHost
    CreateLanguageServiceHostParams
    createProjectLanguageService
    CreateProjectLanguageServiceParams
    CurrentExposure
    findOverExposure
    FindOverExposureParams
    formatOverExposureFindings
    FormatOverExposureFindingsOptions
    LIFECYCLE_ALLOWLIST
    OverExposureFileSystem
    OverExposureFinding
    OverExposureProgress
    OverExposureSkipReason
    SuggestedExposure
- nano-staged-config
- npm
- npm-publish
  - Overview
  - publish
- npm-run
- package-lock-integrity
- package-manager
- released-issues
- repo-paths
  - Overview
  - RepoPaths
- root
- shared-config-files
- test-runners
- upstream-sync
- upstream-sync-cli
- validate-declarations
- validate-dependencies
- version

Select theme

On this page

Overview

PageFrontMatter.description?

PageFrontMatter › description?

Type: string | undefined