mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
2244b1161e
* api docs * more docstrings * logs * docs shakeup * fix notes, added intro to all apis * Remove defaults to * add note to events * note * use fira code
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# 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 | Wether a Table of Contents should be displayed with the Markdown. |
|
|
|
|
## See Also
|
|
|
|
* [Markdown][textual.widgets.Markdown] code reference
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
::: textual.widgets.MarkdownViewer
|
|
options:
|
|
heading_level: 2
|