Function syntaxHighlightingShowcase

  • TypeDoc supports code blocks in Markdown and uses Shiki to provide syntax highlighting.

    If no language is specified, the code block is assumed to be TypeScript:

    // A fabulous variable
    const x: number | string = 12

    You can specify the language at the start of your code block like this:


    Use the tsx language to get JSX support:

    function BasicComponent(): ReactElement {
    return <div>Test</div>

    You might want to write code in the language your backend uses. Here's some Python:

    for i in range(30):
    print(i + 1)

    And some CSS:

    .card {
    background-color: white;
    padding: 1rem;
    border: 1px solid lightgray;

    If you don't want syntax highlighting, use the text language:


    View the full list of supported languages. You can also get this list by running typedoc --help.

    Returns void

Generated using TypeDoc