mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
0bea8b250c
* Initial draft of the howto for packaging an application There's a fair bit more I think needs adding, but this has the core concepts within it. Things still to decide or do are: - How much lead-in and hand-holding is needed for Hatch and Poetry For example, should we walk the reader through the `init` process for Hatch and Poetry, and then guide them to the correct directory in which to create their application, etc? - How to do the example repo Should I do two repos, one for Hatch and one for Poetry? Or should I do one repo with a Hatch and a Poetry example within sub-directories? In either case having a tidy one-to-one relationship with what I talk about in the text won't be quite right. Mainly though I feel the core of what's needed is here (and it's not much, but has taken some testing and checking and whittling down to get here). * Title tweak * Add a note about declaring Textual as a dependency While this might seem obvious, and while some tools will, as a natural consequence of using them, ensure that this happens, it's worth highlighting this so that the reader is mindful of this. Also, someone might be reading the HOWTO while considering how they to this with their own build system. * Break paragraphs down into different lines Just an internal layout thing. Some folk seem to like this sort of thing. * Add a summary * Some rewording * Link to the example repos * Post-initial-proof-read * Link to pip and pipx * Don't repeat help in the same sentence * Remove an actual needless word * Remove the dual use of application in a sentence * Link to TCSS files in case the reader needs a refresh * Explain what the example repositories were built for/with It should be obvious from the names; but it can't hurt to be *very* clear. * Update docs/how-to/package-an-application.md Co-authored-by: Will McGugan <willmcgugan@gmail.com> * Changes in response to feedback * Trim down the into a wee bit * Trim down the into a wee bit more --------- Co-authored-by: Will McGugan <willmcgugan@gmail.com>
225 lines
7.1 KiB
YAML
225 lines
7.1 KiB
YAML
nav:
|
|
- "index.md"
|
|
- Introduction:
|
|
- "getting_started.md"
|
|
- "help.md"
|
|
- "tutorial.md"
|
|
- Guide:
|
|
- "guide/index.md"
|
|
- "guide/devtools.md"
|
|
- "guide/app.md"
|
|
- "guide/styles.md"
|
|
- "guide/CSS.md"
|
|
- "guide/design.md"
|
|
- "guide/queries.md"
|
|
- "guide/layout.md"
|
|
- "guide/events.md"
|
|
- "guide/input.md"
|
|
- "guide/actions.md"
|
|
- "guide/reactivity.md"
|
|
- "guide/widgets.md"
|
|
- "guide/animation.md"
|
|
- "guide/screens.md"
|
|
- "guide/workers.md"
|
|
- "guide/command_palette.md"
|
|
- "guide/testing.md"
|
|
- "widget_gallery.md"
|
|
- Reference:
|
|
- "reference/index.md"
|
|
- CSS Types:
|
|
- "css_types/index.md"
|
|
- "css_types/border.md"
|
|
- "css_types/color.md"
|
|
- "css_types/horizontal.md"
|
|
- "css_types/integer.md"
|
|
- "css_types/keyline.md"
|
|
- "css_types/name.md"
|
|
- "css_types/number.md"
|
|
- "css_types/overflow.md"
|
|
- "css_types/percentage.md"
|
|
- "css_types/scalar.md"
|
|
- "css_types/text_align.md"
|
|
- "css_types/text_style.md"
|
|
- "css_types/vertical.md"
|
|
- Events:
|
|
- "events/index.md"
|
|
- "events/blur.md"
|
|
- "events/descendant_blur.md"
|
|
- "events/descendant_focus.md"
|
|
- "events/enter.md"
|
|
- "events/focus.md"
|
|
- "events/hide.md"
|
|
- "events/key.md"
|
|
- "events/leave.md"
|
|
- "events/load.md"
|
|
- "events/mount.md"
|
|
- "events/mouse_capture.md"
|
|
- "events/click.md"
|
|
- "events/mouse_down.md"
|
|
- "events/mouse_move.md"
|
|
- "events/mouse_release.md"
|
|
- "events/mouse_scroll_down.md"
|
|
- "events/mouse_scroll_up.md"
|
|
- "events/mouse_up.md"
|
|
- "events/paste.md"
|
|
- "events/resize.md"
|
|
- "events/screen_resume.md"
|
|
- "events/screen_suspend.md"
|
|
- "events/show.md"
|
|
- Styles:
|
|
- "styles/align.md"
|
|
- "styles/background.md"
|
|
- "styles/border.md"
|
|
- "styles/border_subtitle_align.md"
|
|
- "styles/border_subtitle_background.md"
|
|
- "styles/border_subtitle_color.md"
|
|
- "styles/border_subtitle_style.md"
|
|
- "styles/border_title_align.md"
|
|
- "styles/border_title_background.md"
|
|
- "styles/border_title_color.md"
|
|
- "styles/border_title_style.md"
|
|
- "styles/box_sizing.md"
|
|
- "styles/color.md"
|
|
- "styles/content_align.md"
|
|
- "styles/display.md"
|
|
- "styles/dock.md"
|
|
- "styles/index.md"
|
|
- "styles/keyline.md"
|
|
- Grid:
|
|
- "styles/grid/index.md"
|
|
- "styles/grid/column_span.md"
|
|
- "styles/grid/grid_columns.md"
|
|
- "styles/grid/grid_gutter.md"
|
|
- "styles/grid/grid_rows.md"
|
|
- "styles/grid/grid_size.md"
|
|
- "styles/grid/row_span.md"
|
|
- "styles/height.md"
|
|
- "styles/layer.md"
|
|
- "styles/layers.md"
|
|
- "styles/layout.md"
|
|
- Links:
|
|
- "styles/links/index.md"
|
|
- "styles/links/link_background.md"
|
|
- "styles/links/link_background_hover.md"
|
|
- "styles/links/link_color.md"
|
|
- "styles/links/link_color_hover.md"
|
|
- "styles/links/link_style.md"
|
|
- "styles/links/link_style_hover.md"
|
|
- "styles/margin.md"
|
|
- "styles/max_height.md"
|
|
- "styles/max_width.md"
|
|
- "styles/min_height.md"
|
|
- "styles/min_width.md"
|
|
- "styles/offset.md"
|
|
- "styles/opacity.md"
|
|
- "styles/outline.md"
|
|
- "styles/overflow.md"
|
|
- "styles/padding.md"
|
|
- Scrollbar colors:
|
|
- "styles/scrollbar_colors/index.md"
|
|
- "styles/scrollbar_colors/scrollbar_background.md"
|
|
- "styles/scrollbar_colors/scrollbar_background_active.md"
|
|
- "styles/scrollbar_colors/scrollbar_background_hover.md"
|
|
- "styles/scrollbar_colors/scrollbar_color.md"
|
|
- "styles/scrollbar_colors/scrollbar_color_active.md"
|
|
- "styles/scrollbar_colors/scrollbar_color_hover.md"
|
|
- "styles/scrollbar_colors/scrollbar_corner_color.md"
|
|
- "styles/scrollbar_gutter.md"
|
|
- "styles/scrollbar_size.md"
|
|
- "styles/text_align.md"
|
|
- "styles/text_opacity.md"
|
|
- "styles/text_style.md"
|
|
- "styles/tint.md"
|
|
- "styles/visibility.md"
|
|
- "styles/width.md"
|
|
- Widgets:
|
|
- "widgets/button.md"
|
|
- "widgets/checkbox.md"
|
|
- "widgets/collapsible.md"
|
|
- "widgets/content_switcher.md"
|
|
- "widgets/data_table.md"
|
|
- "widgets/digits.md"
|
|
- "widgets/directory_tree.md"
|
|
- "widgets/footer.md"
|
|
- "widgets/header.md"
|
|
- "widgets/index.md"
|
|
- "widgets/input.md"
|
|
- "widgets/label.md"
|
|
- "widgets/list_item.md"
|
|
- "widgets/list_view.md"
|
|
- "widgets/loading_indicator.md"
|
|
- "widgets/log.md"
|
|
- "widgets/markdown_viewer.md"
|
|
- "widgets/markdown.md"
|
|
- "widgets/option_list.md"
|
|
- "widgets/placeholder.md"
|
|
- "widgets/pretty.md"
|
|
- "widgets/progress_bar.md"
|
|
- "widgets/radiobutton.md"
|
|
- "widgets/radioset.md"
|
|
- "widgets/rich_log.md"
|
|
- "widgets/rule.md"
|
|
- "widgets/select.md"
|
|
- "widgets/selection_list.md"
|
|
- "widgets/sparkline.md"
|
|
- "widgets/static.md"
|
|
- "widgets/switch.md"
|
|
- "widgets/tabbed_content.md"
|
|
- "widgets/tabs.md"
|
|
- "widgets/text_area.md"
|
|
- "widgets/toast.md"
|
|
- "widgets/tree.md"
|
|
- API:
|
|
- "api/index.md"
|
|
- "api/app.md"
|
|
- "api/await_complete.md"
|
|
- "api/await_remove.md"
|
|
- "api/binding.md"
|
|
- "api/cache.md"
|
|
- "api/color.md"
|
|
- "api/command.md"
|
|
- "api/containers.md"
|
|
- "api/content_switcher.md"
|
|
- "api/coordinate.md"
|
|
- "api/dom_node.md"
|
|
- "api/events.md"
|
|
- "api/errors.md"
|
|
- "api/filter.md"
|
|
- "api/fuzzy_matcher.md"
|
|
- "api/geometry.md"
|
|
- "api/lazy.md"
|
|
- "api/logger.md"
|
|
- "api/logging.md"
|
|
- "api/map_geometry.md"
|
|
- "api/message_pump.md"
|
|
- "api/message.md"
|
|
- "api/on.md"
|
|
- "api/pilot.md"
|
|
- "api/query.md"
|
|
- "api/reactive.md"
|
|
- "api/renderables.md"
|
|
- "api/screen.md"
|
|
- "api/scrollbar.md"
|
|
- "api/scroll_view.md"
|
|
- "api/strip.md"
|
|
- "api/suggester.md"
|
|
- "api/system_commands_source.md"
|
|
- "api/timer.md"
|
|
- "api/types.md"
|
|
- "api/validation.md"
|
|
- "api/walk.md"
|
|
- "api/widget.md"
|
|
- "api/work.md"
|
|
- "api/worker.md"
|
|
- "api/worker_manager.md"
|
|
- "How To":
|
|
- "how-to/index.md"
|
|
- "how-to/center-things.md"
|
|
- "how-to/design-a-layout.md"
|
|
- "how-to/package-an-application.md"
|
|
- "how-to/render-and-compose.md"
|
|
- "FAQ.md"
|
|
- "roadmap.md"
|
|
- "Blog":
|
|
- blog/index.md
|