Options
All
  • Public
  • Public/Protected
  • All
Menu

Module toc

Index

Variables

ITableOfContentsRegistry

ITableOfContentsRegistry: Token<TableOfContentsRegistry>

Table of contents registry token.

Functions

Private createLatexGenerator

  • Returns a ToC generator for LaTeX files.

    Parameters

    Returns IGenerator<IDocumentWidget<FileEditor>>

    ToC generator capable of parsing LaTeX files

Private createMarkdownGenerator

createNotebookGenerator

  • Returns a ToC generator for notebooks.

    Parameters

    Returns IGenerator<NotebookPanel>

    ToC generator capable of parsing notebooks

Private createPythonGenerator

  • Returns a ToC generator for Python files.

    Parameters

    Returns IGenerator<IDocumentWidget<FileEditor>>

    ToC generator capable of parsing Python files

createRenderedMarkdownGenerator

isNotebookHeading

  • isNotebookHeading(heading: any): boolean
  • Tests whether a heading is a notebook heading.

    Parameters

    • heading: any

      heading to test

    Returns boolean

    boolean indicating whether a heading is a notebook heading

Generated using TypeDoc