Skip to content

Commit

Permalink
update docs with syntax extras
Browse files Browse the repository at this point in the history
  • Loading branch information
willmcgugan committed Feb 26, 2025
1 parent 04ba568 commit fd26e24
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/examples/widgets/text_area_custom_language.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def compose(self) -> ComposeResult:
text_area.cursor_blink = False

# Register the Java language and highlight query
text_area.register_language(java_language, java_highlight_query)
text_area.register_language("java", java_language, java_highlight_query)

# Switch to Java
text_area.language = "java"
Expand Down
12 changes: 10 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@

All you need to get started building Textual apps.

## Requirements

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.

!!! info inline end "Your platform"
!!! info "Your platform"

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

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

### :material-apple: macOS

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/).
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/).

### :material-microsoft-windows: Windows

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


## Installation

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

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:

```
pip install "textual[syntax]"
```

### From conda-forge

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):
Expand Down

0 comments on commit fd26e24

Please sign in to comment.