This seeks to remove the "_" from the key presses of snapshots and inline runs in the documentation. The "_" no longer does anything, but got legacy reasons at the moment we can't actually allow "_" to be an input to a "faked" keypress in the docs and snapshots. Removing these clears the way to letting "_" have the same status as any other character. See #1994.
88 lines
1.9 KiB
Markdown
88 lines
1.9 KiB
Markdown
# Introduction
|
|
|
|
Welcome to the [Textual](https://github.com/Textualize/textual) framework documentation.
|
|
|
|
!!! tip
|
|
|
|
See the navigation links in the header or side-bars. Click the :octicons-three-bars-16: button (top left) on mobile.
|
|
|
|
|
|
[Get started](./getting_started.md){ .md-button .md-button--primary } or go straight to the [Tutorial](./tutorial.md)
|
|
|
|
|
|
|
|
## What is Textual?
|
|
|
|
Textual is a *Rapid Application Development* framework for Python, built by [Textualize.io](https://www.textualize.io).
|
|
|
|
|
|
Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and (*coming soon*) a web browser.
|
|
|
|
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-clock-fast:{ .lg .middle } :material-language-python:{. lg .middle } __Rapid development__
|
|
|
|
---
|
|
|
|
Uses your existing Python skills to build beautiful user interfaces.
|
|
|
|
|
|
- :material-raspberry-pi:{ .lg .middle } __Low requirements__
|
|
|
|
---
|
|
|
|
Run Textual on a single board computer if you want to.
|
|
|
|
|
|
|
|
- :material-microsoft-windows:{ .lg .middle } :material-apple:{ .lg .middle } :fontawesome-brands-linux:{ .lg .middle } __Cross platform__
|
|
|
|
---
|
|
|
|
Textual runs just about everywhere.
|
|
|
|
|
|
|
|
- :material-network:{ .lg .middle } __Remote__
|
|
|
|
---
|
|
|
|
Textual apps can run over SSH.
|
|
|
|
|
|
- :fontawesome-solid-terminal:{ .lg .middle } __CLI Integration__
|
|
|
|
---
|
|
|
|
Textual apps can be launched and run from the command prompt.
|
|
|
|
|
|
|
|
- :material-scale-balance:{ .lg .middle } __Open Source__
|
|
|
|
---
|
|
|
|
Textual is licensed under MIT.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
```{.textual path="examples/calculator.py" columns=100 lines=41 press="3,.,1,4,5,9,2,wait:400"}
|
|
```
|
|
|
|
```{.textual path="examples/pride.py"}
|
|
```
|
|
|
|
```{.textual path="docs/examples/tutorial/stopwatch.py" columns="100" lines="30" press="d,tab,enter"}
|
|
```
|
|
|
|
|
|
```{.textual path="docs/examples/guide/layout/combining_layouts.py" columns="100", lines="30"}
|
|
```
|
|
|
|
```{.textual path="docs/examples/app/widgets01.py"}
|
|
```
|