Skip to content

Broken Link in themes Docstring – Dual Themes Documentation Not Found #1034

@1chooo

Description

@1chooo

Description:

The docstring for the themes property in the ThemeRegistrationAny | StringLiteralUnion<Themes> type currently references a non-existent URL:

/**
 * @see https://github.com/shikijs/shiki#lightdark-dual-themes
 */
themes: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<Themes>>>

However, the link https://github.com/shikijs/shiki#lightdark-dual-themes is broken because the section is not existed in README.

Source:
options.ts Line 83

Suggestion:

  • Update the docstring with the correct link to the documentation for dual theme support.
  • If the documentation has moved or been removed, consider adding a short inline explanation or pointing to the relevant usage example or README section.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions