docs/widgets/markdown_viewer.md
!!! tip "Added in version 0.11.0"
A Widget to display Markdown content with an optional Table of Contents.
!!! note
This Widget adds browser-like functionality on top of the [Markdown](./markdown.md) widget.
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"
~~~
| Name | Type | Default | Description |
|---|---|---|---|
show_table_of_contents | bool | True | Whether a Table of Contents should be displayed with the Markdown. |
This widget posts no messages.
This widget has no bindings.
This widget has no component classes.
::: textual.widgets.MarkdownViewer options: heading_level: 2
::: textual.widgets.markdown options: show_root_heading: true show_root_toc_entry: true