Language graphql not found Error

[timothymathison]

Search terms

• language
• highlight
• graphql code block
• may need to load it first
• output could not be generated

Expected Behavior

Should generate docs successfully that contain graphql code blocks.

Actual Behavior

After upgrading from v0.28.2 to v0.28.3, I receive the following error:

[error] Language graphql not found, you may need to load it first
[error] html output could not be generated due to the errors above
[error] Found 2 errors and 3 warnings

Steps to reproduce the bug

1. Project with typedocs that contain graphql code block
2. Set version of typedoc to 0.28.3
3. Run:

   npx typedoc src --disableSources --out docs/
   

Contents of tsconfig.json

{
  "exclude": [
    "src/test/**.ts",
    "**/*.test.ts"
  ]
}

Environment

• Typedoc version: 0.28.3
• TypeScript version: 5.7.3
• Node.js version: 20.9.0
• OS: Mac and Linux

[Gerrit0]

Graphql is not in TypeDoc's list of default languages to load for the highlighter. If it worked before, this is likely because some Shiki grammar incorrectly specified it as a dependency, causing it to be loaded, which was fixed in a later release.

You can control what languages typedoc loads, only a few are loaded by default to minimize the overhead from loading unused languages. See https://typedoc.org/documents/Options.Output.html#highlightlanguages

[timothymathison]

Graphql is not in TypeDoc's list of default languages to load for the highlighter. If it worked before, this is likely because some Shiki grammar incorrectly specified it as a dependency, causing it to be loaded, which was fixed in a later release.

You can control what languages typedoc loads, only a few are loaded by default to minimize the overhead from loading unused languages. See https://typedoc.org/documents/Options.Output.html#highlightlanguages

Thanks, @Gerrit0. I had trouble finding that configuration option and identifying the languages loaded by default. And running typedoc --help showed graphql as supported. Perhaps, the docs describing codeblock support should mention the loading requirement and link to the docs for that option.

Specifying highlightLanguages inside typedoc.json and adding graphql fixed the error for me. In my case, I also had to add yaml. So, at least those two languages have been inadvertently removed from loading by default. I imagine there may be others.

[unmultimedio]

@Gerrit0 Just bumped into this issue, with another language. According to the docs:

By default, TypeDoc will produce an error if a code block specifies a language which is not present in the highlightLanguages array.

I wonder if there's a way to tell TypeDoc to not fail for unknown languages, but instead just render w/out highlight. I can open a new issue with this question if you want.

[Gerrit0]

That makes sense to me, it really ought to just be a warning and highlighting skipped

[zaysayd]

***@***.*** در تاریخ سه‌شنبه ۱۳ مه ۲۰۲۵،‏ ۰۳:۵۷ Saeid Zare ***@***.***> نوشت:

…

تایید می کنم سعیدزارع ***@***.*** در تاریخ دوشنبه ۱۲ مه ۲۰۲۵،‏ ۲۱:۲۳ Julian Figueroa < ***@***.***> نوشت: > *unmultimedio* left a comment (TypeStrong/typedoc#2943) > <#2943 (comment)> > > @Gerrit0 <https://github.com/Gerrit0> Just bumped into this issue, with > another language. According to the docs > <https://typedoc.org/documents/Options.Output.html#ignoredhighlightlanguages> > : > > By default, TypeDoc will produce an error if a code block specifies a > language which is not present in the highlightLanguages array. > > I wonder if there's a way to tell TypeDoc to not fail for unknown > languages, but instead just render w/out highlight. I can open a new issue > with this question if you want. > > — > Reply to this email directly, view it on GitHub > <#2943 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BN7VBOAPHRNKQE77TODEAK326DNY7AVCNFSM6AAAAAB32BKP7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNZTGQ3DEOBXGI> > . > You are receiving this because you are subscribed to this thread.Message > ID: ***@***.***> >

[zaysayd]

***@***.*** در تاریخ سه‌شنبه ۱۳ مه ۲۰۲۵،‏ ۰۳:۵۸ Saeid Zare ***@***.***> نوشت:

…

***@***.*** در تاریخ سه‌شنبه ۱۳ مه ۲۰۲۵،‏ ۰۳:۵۷ Saeid Zare ***@***.***> نوشت: > تایید می کنم سعیدزارع > ***@***.*** > > در تاریخ دوشنبه ۱۲ مه ۲۰۲۵،‏ ۲۱:۲۳ Julian Figueroa < > ***@***.***> نوشت: > >> *unmultimedio* left a comment (TypeStrong/typedoc#2943) >> <#2943 (comment)> >> >> @Gerrit0 <https://github.com/Gerrit0> Just bumped into this issue, with >> another language. According to the docs >> <https://typedoc.org/documents/Options.Output.html#ignoredhighlightlanguages> >> : >> >> By default, TypeDoc will produce an error if a code block specifies a >> language which is not present in the highlightLanguages array. >> >> I wonder if there's a way to tell TypeDoc to not fail for unknown >> languages, but instead just render w/out highlight. I can open a new issue >> with this question if you want. >> >> — >> Reply to this email directly, view it on GitHub >> <#2943 (comment)>, >> or unsubscribe >> <https://github.com/notifications/unsubscribe-auth/BN7VBOAPHRNKQE77TODEAK326DNY7AVCNFSM6AAAAAB32BKP7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNZTGQ3DEOBXGI> >> . >> You are receiving this because you are subscribed to this thread.Message >> ID: ***@***.***> >> >

[zaysayd]

تایید می کنم سعیدزارع ***@***.*** در تاریخ دوشنبه ۱۲ مه ۲۰۲۵،‏ ۲۱:۲۳ Julian Figueroa ***@***.***> نوشت:

…

*unmultimedio* left a comment (TypeStrong/typedoc#2943) <#2943 (comment)> @Gerrit0 <https://github.com/Gerrit0> Just bumped into this issue, with another language. According to the docs <https://typedoc.org/documents/Options.Output.html#ignoredhighlightlanguages> : By default, TypeDoc will produce an error if a code block specifies a language which is not present in the highlightLanguages array. I wonder if there's a way to tell TypeDoc to not fail for unknown languages, but instead just render w/out highlight. I can open a new issue with this question if you want. — Reply to this email directly, view it on GitHub <#2943 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BN7VBOAPHRNKQE77TODEAK326DNY7AVCNFSM6AAAAAB32BKP7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQNZTGQ3DEOBXGI> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>