Docs Party 2024 (#15876)
Co-authored-by: Raunak Raj <nkray21111983@gmail.com> Co-authored-by: Thorsten Ball <mrnugget@gmail.com> Co-authored-by: Bennet <bennet@zed.dev> Co-authored-by: Marshall Bowers <elliott.codes@gmail.com> Co-authored-by: Joseph T Lyons <JosephTLyons@gmail.com> Co-authored-by: Mikayla <mikayla@zed.dev> Co-authored-by: Jason <jason@zed.dev> Co-authored-by: Antonio Scandurra <me@as-cii.com> Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com> Co-authored-by: Marshall <marshall@zed.dev> Co-authored-by: Nathan Sobo <nathan@zed.dev> Co-authored-by: Jason Mancuso <7891333+jvmncs@users.noreply.github.com> Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com>
This commit is contained in:
co-authored by
Raunak Raj
Thorsten Ball
Bennet
Marshall Bowers
Joseph T Lyons
Mikayla
Jason
Antonio Scandurra
Max Brunsfeld
Marshall
Nathan Sobo
Jason Mancuso
Piotr Osiewicz
parent
c633fa5a10
commit
eb3c4b0e46
@@ -0,0 +1,53 @@
|
||||
# Themes
|
||||
|
||||
The `themes` directory in an extension should contain one or more theme files.
|
||||
|
||||
Each theme file should adhere to the JSON schema specified at [`https://zed.dev/schema/themes/v0.1.0.json`](https://zed.dev/schema/themes/v0.1.0.json).
|
||||
|
||||
See [this blog post](https://zed.dev/blog/user-themes-now-in-preview) for more details about creating themes.
|
||||
|
||||
## Theme JSON Structure
|
||||
|
||||
The structure of a Zed theme is defined in the [Zed Theme JSON Schema](https://zed.dev/schema/themes/v0.1.0.json).
|
||||
|
||||
A Zed theme consists of a Theme Family object including:
|
||||
|
||||
- `name`: The name for the theme family
|
||||
- `author`: The name of the author of the theme family
|
||||
- `themes`: An array of Themes belonging to the theme family
|
||||
|
||||
The core components a Theme object include:
|
||||
|
||||
1. Theme Metadata:
|
||||
|
||||
- `name`: The name of the theme
|
||||
- `appearance`: Either "light" or "dark"
|
||||
|
||||
2. Style Properties under the `style`, such as:
|
||||
|
||||
- `background`: The main background color
|
||||
- `foreground`: The main text color
|
||||
- `accent`: The accent color used for highlighting and emphasis
|
||||
|
||||
3. Syntax Highlighting:
|
||||
|
||||
- `syntax`: An object containing color definitions for various syntax elements (e.g., keywords, strings, comments)
|
||||
|
||||
4. UI Elements:
|
||||
|
||||
- Colors for various UI components such as:
|
||||
- `element.background`: Background color for UI elements
|
||||
- `border`: Border colors for different states (normal, focused, selected)
|
||||
- `text`: Text colors for different states (normal, muted, accent)
|
||||
|
||||
5. Editor-specific Colors:
|
||||
|
||||
- Colors for editor-related elements such as:
|
||||
- `editor.background`: Editor background color
|
||||
- `editor.gutter`: Gutter colors
|
||||
- `editor.line_number`: Line number colors
|
||||
|
||||
6. Terminal Colors:
|
||||
- ANSI color definitions for the integrated terminal
|
||||
|
||||
We recommend looking at our [existing themes](https://github.com/zed-industries/zed/tree/main/assets/themes) to get a more comprehensive idea of what can be styled.
|
||||
Reference in New Issue
Block a user