Back to Textual

MarkdownViewer

docs/widgets/markdown_viewer.md

8.2.51.3 KB
Original Source

MarkdownViewer

!!! tip "Added in version 0.11.0"

A Widget to display Markdown content with an optional Table of Contents.

  • Focusable
  • Container

!!! note

This Widget adds browser-like functionality on top of the [Markdown](./markdown.md) widget.

Example

The following example displays Markdown from a string and a Table of Contents.

=== "Output"

```{.textual path="docs/examples/widgets/markdown_viewer.py" columns="100" lines="42"}
```

=== "markdown.py"

~~~python
--8<-- "docs/examples/widgets/markdown_viewer.py"
~~~

Reactive Attributes

NameTypeDefaultDescription
show_table_of_contentsboolTrueWhether a Table of Contents should be displayed with the Markdown.

Messages

This widget posts no messages.

Bindings

This widget has no bindings.

Component Classes

This widget has no component classes.

See Also

  • [Markdown][textual.widgets.Markdown] code reference

::: textual.widgets.MarkdownViewer options: heading_level: 2

::: textual.widgets.markdown options: show_root_heading: true show_root_toc_entry: true