yenru0/zed

0 Fork 0

Files

T

morgankrey 9168df6260 docs: Apply documentation standards across all docs (#49177 )

## Summary

Comprehensive remediation of 146 documentation files to align with Zed's
documentation conventions and brand voice guidelines.

## Changes

### YAML Frontmatter
- Added `title` and `description` frontmatter to all docs missing it

### Settings UI Pattern
- Updated 48+ files to show Settings Editor before JSON examples
- Pattern: `Configure X in Settings ({#kb zed::OpenSettings}), or add to
your settings file:`
- Added `([how to edit](./configuring-zed.md#settings-files))` links for
JSON-only settings

### Brand Voice Fixes
- Removed exclamation points (command-palette, key-bindings, repl,
privacy-and-security, etc.)
- Simplified em dash chains to parentheticals (environment,
troubleshooting, agent-panel, etc.)
- Fixed marketing language (yarn.md intro, development/linux.md)

### Terminology Alignment
- `settings UI` -> `Settings Editor`
- `sidebar` -> specific panel names (Project Panel, Collab Panel)
- `directory` -> `folder` in non-technical contexts
- `workspace` -> `project` in non-LSP contexts
- `Command Palette` -> `command palette` (lowercase)

### Callout Standardization
- Converted various callout formats to standard `> **Note:**` pattern

## Related

Depends on conventions established in #49176.

Release Notes:

- N/A

2026-02-17 20:58:17 -06:00

2.1 KiB

Raw Blame History

title, description

title	description
Themes	Themes for Zed extensions.

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.2.0.json.

See this blog post for additional background on creating themes.

Theme JSON Structure

The structure of a Zed theme is defined in the Zed Theme JSON Schema.

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 of a Theme object include:

Theme Metadata:
- name: The name of the theme
- appearance: Either "light" or "dark"
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
Syntax Highlighting:
- syntax: An object containing color definitions for various syntax elements (e.g., keywords, strings, comments)
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)
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
Terminal Colors:
- ANSI color definitions for the integrated terminal

Designing Your Theme

You can use Zed's Theme Builder to design your own custom theme based on an existing one.

This tool lets you fine-tune and preview how surfaces in Zed will look. You can then export the JSON and publish it in Zed's extension store.

2.1 KiB Raw Blame History

Themes

Theme JSON Structure

Designing Your Theme

2.1 KiB

Raw Blame History