Skip to content

Consider adding text to the default highlightLanguages option #2610

@xuhdev

Description

@xuhdev

Search terms

syntax highlighting

Expected Behavior

Since typedoc defaults code blocks to typescript, the plain text syntax highlighter should work out of the box.

Actual Behavior

If not modifying highlightLanguages, typedoc would issue a warning:

[warning] Code block with language text will not be highlighted in comment for ... as it was not included in the highlightLanguages option

Environment

  • Typedoc version: 0.26.1

Additional Context

This is only a request, since a user can always add text to highlightLanguages. However, since text is so common, I request considering adding it as default.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions