Skip to content

Commit fd26e24

Browse files
committed
update docs with syntax extras
1 parent 04ba568 commit fd26e24

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

docs/examples/widgets/text_area_custom_language.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def compose(self) -> ComposeResult:
2222
text_area.cursor_blink = False
2323

2424
# Register the Java language and highlight query
25-
text_area.register_language(java_language, java_highlight_query)
25+
text_area.register_language("java", java_language, java_highlight_query)
2626

2727
# Switch to Java
2828
text_area.language = "java"

docs/getting_started.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
1+
12
All you need to get started building Textual apps.
23

34
## Requirements
45

56
Textual requires Python 3.8 or later (if you have a choice, pick the most recent Python). Textual runs on Linux, macOS, Windows and probably any OS where Python also runs.
67

7-
!!! info inline end "Your platform"
8+
!!! info "Your platform"
89

910
### :fontawesome-brands-linux: Linux (all distros)
1011

1112
All Linux distros come with a terminal emulator that can run Textual apps.
1213

1314
### :material-apple: macOS
1415

15-
The default terminal app is limited to 256 colors. We recommend installing a newer terminal such as [iterm2](https://iterm2.com/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/).
16+
The default terminal app is limited to 256 colors. We recommend installing a newer terminal such as [iterm2](https://iterm2.com/), [Ghostty](https://ghostty.org/), [Kitty](https://sw.kovidgoyal.net/kitty/), or [WezTerm](https://wezfurlong.org/wezterm/).
1617

1718
### :material-microsoft-windows: Windows
1819

1920
The new [Windows Terminal](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701?hl=en-gb&gl=GB) runs Textual apps beautifully.
2021

22+
2123
## Installation
2224

2325
Here's how to install Textual.
@@ -36,6 +38,12 @@ If you plan on developing Textual apps, you should also install textual develope
3638
pip install textual-dev
3739
```
3840

41+
If you would like to enable syntax highlighting in the [TextArea](./widgets/text_area.md) widget, you should specify the "syntax" extras when you install Textual:
42+
43+
```
44+
pip install "textual[syntax]"
45+
```
46+
3947
### From conda-forge
4048

4149
Textual is also available on [conda-forge](https://conda-forge.org/). The preferred package manager for conda-forge is currently [micromamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html):

0 commit comments

Comments
 (0)