NgDocShikiLanguage · API

A Shiki (TextMate) language registration: a grammar and the name that code blocks use for it. It must be plain JSON data, as in a .tmLanguage.json file or a module of @shikijs/langs.

DeclarationTypeScript

export interface NgDocShikiLanguage { … }

Members

Properties 11
aliases?: `string[] \| undefined`	Other names that code blocks can use for the language.
displayName?: `string \| undefined`	The name to display for the language.
embeddedLangs?: `string[] \| undefined`	The languages that the grammar embeds, which must be bundled or registered too.
embeddedLangsLazy?: `string[] \| undefined`	The languages that the grammar embeds when they are loaded.
injections?: `unknown`	TextMate injections.
injectionSelector?: `string \| undefined`	The selector of an injection grammar.
injectTo?: `string[] \| undefined`	The scopes that the grammar injects itself into.
name: `string`	The language name: code blocks that name it (for example ```my-lang) use the grammar.
patterns?: `unknown`	The TextMate rules of the grammar.
repository?: `unknown`	The named TextMate rules that `patterns` include.
scopeName: `string`	The root scope of the grammar, such as `source.my-lang`.

Members

Properties