mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
added doc indexes
This commit is contained in:
3
docs/events/index.md
Normal file
3
docs/events/index.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Events
|
||||||
|
|
||||||
|
A reference to Textual [events](../guide/events.md).
|
||||||
9
docs/guide/index.md
Normal file
9
docs/guide/index.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Textual Guide
|
||||||
|
|
||||||
|
Welcome to the Textual Guide! An in-depth reference on how to build app with Textual.
|
||||||
|
|
||||||
|
## Example code
|
||||||
|
|
||||||
|
Most of the code in this guide is fully working—you could cut and paste it if you wanted to.
|
||||||
|
|
||||||
|
Although it is probably easier to check out the [Textual repository](https://github.com/Textualize/textual) and navigate to the `docs/examples/guide` directory and run the examples from there.
|
||||||
3
docs/how-to/index.md
Normal file
3
docs/how-to/index.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# How to ...
|
||||||
|
|
||||||
|
For those who want more focused information on Textual features.
|
||||||
3
docs/reference/index.md
Normal file
3
docs/reference/index.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Reference
|
||||||
|
|
||||||
|
A reference to the Textual public APIs.
|
||||||
3
docs/styles/index.md
Normal file
3
docs/styles/index.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Styles
|
||||||
|
|
||||||
|
A reference to Widget [styles](../guide/styles.md).
|
||||||
3
docs/widgets/index.md
Normal file
3
docs/widgets/index.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Widgets
|
||||||
|
|
||||||
|
A reference to the builtin [widgets](../guide/widgets.md).
|
||||||
14
mkdocs.yml
14
mkdocs.yml
@@ -6,6 +6,7 @@ nav:
|
|||||||
- "getting_started.md"
|
- "getting_started.md"
|
||||||
- "tutorial.md"
|
- "tutorial.md"
|
||||||
- Guide:
|
- Guide:
|
||||||
|
- "guide/index.md"
|
||||||
- "guide/devtools.md"
|
- "guide/devtools.md"
|
||||||
- "guide/app.md"
|
- "guide/app.md"
|
||||||
- "guide/styles.md"
|
- "guide/styles.md"
|
||||||
@@ -17,11 +18,12 @@ nav:
|
|||||||
- "guide/widgets.md"
|
- "guide/widgets.md"
|
||||||
- "guide/screens.md"
|
- "guide/screens.md"
|
||||||
- How to:
|
- How to:
|
||||||
|
- "how-to/index.md"
|
||||||
- "how-to/animation.md"
|
- "how-to/animation.md"
|
||||||
- "how-to/mouse-and-keyboard.md"
|
- "how-to/mouse-and-keyboard.md"
|
||||||
- "how-to/scroll.md"
|
- "how-to/scroll.md"
|
||||||
- "actions.md"
|
|
||||||
- Events:
|
- Events:
|
||||||
|
- "events/index.md"
|
||||||
- "events/blur.md"
|
- "events/blur.md"
|
||||||
- "events/descendant_blur.md"
|
- "events/descendant_blur.md"
|
||||||
- "events/descendant_focus.md"
|
- "events/descendant_focus.md"
|
||||||
@@ -47,6 +49,7 @@ nav:
|
|||||||
- "events/screen_suspend.md"
|
- "events/screen_suspend.md"
|
||||||
- "events/show.md"
|
- "events/show.md"
|
||||||
- Styles:
|
- Styles:
|
||||||
|
- "styles/index.md"
|
||||||
- "styles/background.md"
|
- "styles/background.md"
|
||||||
- "styles/border.md"
|
- "styles/border.md"
|
||||||
- "styles/box_sizing.md"
|
- "styles/box_sizing.md"
|
||||||
@@ -75,6 +78,7 @@ nav:
|
|||||||
- "styles/visibility.md"
|
- "styles/visibility.md"
|
||||||
- "styles/width.md"
|
- "styles/width.md"
|
||||||
- Widgets:
|
- Widgets:
|
||||||
|
- "widgets/index.md"
|
||||||
- "widgets/button.md"
|
- "widgets/button.md"
|
||||||
- "widgets/data_table.md"
|
- "widgets/data_table.md"
|
||||||
- "widgets/footer.md"
|
- "widgets/footer.md"
|
||||||
@@ -82,6 +86,7 @@ nav:
|
|||||||
- "widgets/static.md"
|
- "widgets/static.md"
|
||||||
- "widgets/tree_control.md"
|
- "widgets/tree_control.md"
|
||||||
- Reference:
|
- Reference:
|
||||||
|
- "reference/index.md"
|
||||||
- "reference/app.md"
|
- "reference/app.md"
|
||||||
- "reference/button.md"
|
- "reference/button.md"
|
||||||
- "reference/color.md"
|
- "reference/color.md"
|
||||||
@@ -128,8 +133,9 @@ markdown_extensions:
|
|||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
custom_dir: custom_theme
|
custom_dir: custom_theme
|
||||||
# features:
|
features:
|
||||||
# - navigation.tabs
|
- navigation.tabs
|
||||||
|
- navigation.indexes
|
||||||
palette:
|
palette:
|
||||||
- media: "(prefers-color-scheme: light)"
|
- media: "(prefers-color-scheme: light)"
|
||||||
scheme: default
|
scheme: default
|
||||||
|
|||||||
2
poetry.lock
generated
2
poetry.lock
generated
@@ -345,7 +345,7 @@ mkdocs = ">=1.1"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "mkdocs-material"
|
name = "mkdocs-material"
|
||||||
version = "8.4.1"
|
version = "8.4.2"
|
||||||
description = "Documentation that simply works"
|
description = "Documentation that simply works"
|
||||||
category = "dev"
|
category = "dev"
|
||||||
optional = false
|
optional = false
|
||||||
|
|||||||
Reference in New Issue
Block a user