GitHubJupyter
  • Preparing search index...
  • The search index is not available
@jupyterlab
  • @jupyterlab
  • toc
  • TableOfContentsUtils
  • Markdown
  • getHeadingId

Function getHeadingId

  • getHeadingId(
        markdownParser: IMarkdownParser,
        raw: string,
        level: number,
        sanitizer?: IRenderMime.ISanitizer,
    ): Promise<string | null>
  • Build the heading html id.

    Parameters

    • markdownParser: IMarkdownParser
    • raw: string

      Raw markdown heading

    • level: number

      Heading level

    • Optionalsanitizer: IRenderMime.ISanitizer

      HTML sanitizer

    Returns Promise<string | null>

    • Defined in packages/toc/src/utils/markdown.ts:31

Settings

Member Visibility
GitHubJupyter
@jupyterlab
  • Loading...

Generated using TypeDoc