1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
# MarkdownViewer
!!! tip "Added in version 0.11.0"
A Widget to display Markdown content with an optional Table of Contents.
- [x] 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
| Name | Type | Default | Description |
| ------------------------ | ---- | ------- | ------------------------------------------------------------------ |
| `show_table_of_contents` | bool | True | Whether 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
|
