markdown-it-toc-done-right/types/index.d.ts

Table of contents (TOC) for markdown-it markdown parser with focus on semantic and security.

declare module 'markdown-it-toc-done-right' {
    import MarkdownIt from 'markdown-it/lib'

    export interface TocOptions {
        placeholder: string
        slugify: (s: string) => string
        uniqueSlugStartIndex: number
        containerClass: string
        containerId: string
        listClass: string
        itemClass: string
        linkClass: string
        level: number | number[]
        listType: 'ol' | 'ul'
        format: (s: string) => string
        callback: (tocCode: string, ast: TocAst) => void
    }

    export interface TocAst {
        l: number
        n: string
        c: TocAst[]
    }

    const markdownItTocDoneRight: MarkdownIt.PluginWithOptions<Partial<TocOptions>>

    export default markdownItTocDoneRight
}