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
npm install --save-dev typedoc
A TypeScript code block:
// A fabulous variableconst x: number | string = 12 Copy
// A fabulous variableconst x: number | string = 12
See syntaxHighlightingShowcase for more code blocks.
syntaxHighlightingShowcase
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.
Markdown Showcase
All comments are parsed as Markdown. TypeDoc uses the Marked markdown parser to convert comments to HTML.
Symbol References
You can link to other classes, members or functions using an inline link tag. See the TypeDoc documentation for details.
Code in Doc Comments
Some inline code:
npm install --save-dev typedocA TypeScript code block:
See
syntaxHighlightingShowcasefor more code blocks.A List
EggsA Table
A Random Shakespeare Quote
An Image
This requires the media option to be set.