Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider adding text to the default highlightLanguages option #2610

Closed
xuhdev opened this issue Jun 23, 2024 · 2 comments
Closed

Consider adding text to the default highlightLanguages option #2610

xuhdev opened this issue Jun 23, 2024 · 2 comments
Labels
bug Functionality does not match expectation
Milestone

Comments

@xuhdev
Copy link
Contributor

xuhdev commented Jun 23, 2024

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.

@xuhdev xuhdev added the bug Functionality does not match expectation label Jun 23, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 23, 2024

I agree, text should be included.

@TechQuery
Copy link

@Gerrit0 yml or yaml has the same issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

3 participants