mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
docs and refactor
This commit is contained in:
40
docs/widgets/markdown.md
Normal file
40
docs/widgets/markdown.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Markdown
|
||||
|
||||
A widget to display a Markdown document.
|
||||
|
||||
- [x] Focusable
|
||||
- [ ] Container
|
||||
|
||||
|
||||
!!! tip
|
||||
|
||||
See [MarkdownViewer](./markdown_viewer.md) for a widget that adds additional features such as a Table of Contents.
|
||||
|
||||
## Example
|
||||
|
||||
The following example displays Markdown from a string.
|
||||
|
||||
=== "Output"
|
||||
|
||||
```{.textual path="docs/examples/widgets/markdown.py"}
|
||||
```
|
||||
|
||||
=== "markdown.py"
|
||||
|
||||
~~~python
|
||||
--8<-- "docs/examples/widgets/markdown.py"
|
||||
~~~
|
||||
|
||||
## Messages
|
||||
|
||||
### ::: textual.widgets.Markdown.TOCUpdated
|
||||
|
||||
### ::: textual.widgets.Markdown.TOCSelected
|
||||
|
||||
### ::: textual.widgets.Markdown.LinkClicked
|
||||
|
||||
|
||||
## See Also
|
||||
|
||||
* [Markdown][textual.widgets.Markdown] code reference
|
||||
* [MarkdownViewer][textual.widgets.MarkdownViewer] code reference
|
||||
37
docs/widgets/markdown_viewer.md
Normal file
37
docs/widgets/markdown_viewer.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Markdown Viewer
|
||||
|
||||
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_toc` | 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
|
||||
Reference in New Issue
Block a user