All comments are parsed as Markdown. TypeDoc uses the Marked markdown parser to convert comments to HTML.
You can link to other classes, members or functions using an inline link tag. See the TypeDoc documentation for details.
Some inline code:
npm install --save-dev typedoc
A TypeScript code block:
// A fabulous variable
const x: number | string = 12
syntaxHighlightingShowcase for more code blocks.
Rebellious subjects, enemies to peace, Profaners of this neighbour-stained steel,-- Will they not hear? What, ho! you men, you beasts, That quench the fire of your pernicious rage With purple fountains issuing from your veins
This requires the media option to be set.
Generated using TypeDoc