Markdown

Utils for markdown rendering.

Handsdown API Index / Handsdown / Utils / Markdown

Auto-generated documentation for handsdown.utils.markdown module.

Header

Show source in markdown.py:9

Markdown header.

Arguments

• title - Header title
• level - Header level, 1-6
• anchor - Anchor link

Signature

class Header:
    def __init__(self, title: str, level: int, anchor: str) -> None:
        ...

Header().render

Show source in markdown.py:24

Render menu item to string.

Signature

def render(self) -> str:
    ...

TableOfContents

Show source in markdown.py:32

MarkDown Table of Contents.

Arguments

• headers - List of headers

Signature

class TableOfContents:
    def __init__(self, headers: Iterable[Header]) -> None:
        ...

See also

• Header

TableOfContents.parse

Show source in markdown.py:43

Parse table of Contents for MarkDown text.

Arguments

• text - MarkDown text.

Signature

@classmethod
def parse(cls: Type[_R], text: str) -> _R:
    ...

TableOfContents().render

Show source in markdown.py:71

Render ToC to string.

Signature

def render(self, max_level: int = 3) -> str:
    ...

insert_md_toc

Show source in markdown.py:87

Insert Table of Contents before the first second-level header.

Signature

def insert_md_toc(text: str, depth: int = 3) -> str:
    ...