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

cannot allow/skip unsupported highlighting languages #2819

Closed
OmarTawfik opened this issue Dec 23, 2024 · 2 comments
Closed

cannot allow/skip unsupported highlighting languages #2819

OmarTawfik opened this issue Dec 23, 2024 · 2 comments
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@OmarTawfik
Copy link

Users can author code blocks in the docs, which might not be supported by typedoc. This is still a valid use case, because it can be used with typedoc-plugin-markdown, which will write the language-ID as-is to the markdown, to be highlighted by something other than shiki (for example mkdocs).

Search terms

highlight language add ignore

Expected Behavior

Perhaps adding an option like ignoreLanguages next to the existing highlightLanguages, to allow using these other languages. For shiki, it would remain unhighlighted.

Actual Behavior

Without such flag, users are not able to set the correct language-ID, and are blocked from using other systems/markdown plugins.

@OmarTawfik OmarTawfik added the bug Functionality does not match expectation label Dec 23, 2024
@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Dec 23, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 23, 2024

PR welcome

@Gerrit0 Gerrit0 added enhancement Improved functionality and removed bug Functionality does not match expectation labels Dec 25, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 26, 2024

I decided to call the option ignoredHighlightLanguages to more closely match highlightLanguages

shawninder pushed a commit to shawninder/typedoc that referenced this issue Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants