@types/markdown-it-highlightjs

Installation

npm install --save @types/markdown-it-highlightjs

Summary

This package contains type definitions for markdown-it-highlightjs (https://github.com/valeriangalliat/markdown-it-highlightjs).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/markdown-it-highlightjs.

index.d.ts

import hljs = require("highlight.js");
import { PluginWithOptions } from "markdown-it";

declare const highlightjs: PluginWithOptions<{
    /**
     * Whether to automatically detect language if not specified.
     */
    auto?: boolean | undefined;

    /**
     * Whether to add the `hljs` class to raw code blocks (not fenced blocks).
     */
    code?: boolean | undefined;

    /**
     * Register other languages which are not included in the standard pack.
     */
    register?: {
        [language: string]: (hljs?: HLJSApi) => Language;
    } | undefined;

    /**
     * Whether to highlight inline code.
     */
    inline?: boolean | undefined;
}>;

export = highlightjs;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/markdown-it, highlight.js

Credits

These definitions were written by Wilson Gramer.