mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
aad6d98aa5
* Change the title of some widget references to their class names The widget reference index had a slight mixture of widget title styles, some being their class name, others being "written English" type titles. This settles on the titles always being the class name. * Add a link to the ContentSwitcher to the widget gallery No screenshot for this, on purpose. By definition this widget isn't visible, except via other widgets that it's enclosing and handling. * Have mkdocs watch the main nav file * Mark the content switcher off the roadmap
38 lines
1.0 KiB
Markdown
38 lines
1.0 KiB
Markdown
# MarkdownViewer
|
|
|
|
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
|
|
|
|
* [MarkdownViewer][textual.widgets.MarkdownViewer] code reference
|
|
* [Markdown][textual.widgets.Markdown] code reference
|