Skip to content

Outline

marimo.outline

outline(*, label: str = '') -> Html

Display a table of contents outline showing all markdown headers in the notebook.

The outline automatically extracts all markdown headers from executed cells and displays them in a hierarchical structure with clickable navigation.

Examples:

Basic outline:

mo.outline()

With custom label:

mo.outline(label="Table of Contents")

PARAMETER DESCRIPTION
label

A descriptive label for the outline. Defaults to "".

TYPE: str DEFAULT: ''

RETURNS DESCRIPTION
Html

An HTML object that renders the outline component.

TYPE: Html