mirror of
https://github.com/zed-industries/zed.git
synced 2026-11-21 08:01:33 +01:00
6daa541e77
## 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
85 lines
3.1 KiB
Markdown
85 lines
3.1 KiB
Markdown
---
|
|
title: Getting Started with Zed
|
|
description: Get started with Zed, the fast open-source code editor. Essential commands, environment setup, and navigation basics.
|
|
---
|
|
|
|
# Getting Started
|
|
|
|
Zed is an open-source code editor with built-in collaboration and AI tools.
|
|
|
|
This guide covers the essential commands, environment setup, and navigation basics.
|
|
|
|
## Quick Start
|
|
|
|
### 1. Open a Project
|
|
|
|
Open a folder from the command line:
|
|
|
|
```sh
|
|
zed ~/projects/my-app
|
|
```
|
|
|
|
Or use `Cmd+O` (macOS) / `Ctrl+O` (Linux/Windows) to open a folder from within Zed.
|
|
|
|
### 2. Learn the Essential Commands
|
|
|
|
| Action | macOS | Linux/Windows |
|
|
| --------------- | ------------- | -------------- |
|
|
| Command palette | `Cmd+Shift+P` | `Ctrl+Shift+P` |
|
|
| Go to file | `Cmd+P` | `Ctrl+P` |
|
|
| Go to symbol | `Cmd+Shift+O` | `Ctrl+Shift+O` |
|
|
| Find in project | `Cmd+Shift+F` | `Ctrl+Shift+F` |
|
|
| Toggle terminal | `` Ctrl+` `` | `` Ctrl+` `` |
|
|
| Open settings | `Cmd+,` | `Ctrl+,` |
|
|
|
|
The command palette (`Cmd+Shift+P`) is your gateway to every action in Zed. If you forget a shortcut, search for it there.
|
|
|
|
### 3. Configure Your Editor
|
|
|
|
Open the Settings Editor with `Cmd+,` (macOS) or `Ctrl+,` (Linux/Windows). Search for any setting and change it directly.
|
|
|
|
Common first changes:
|
|
|
|
- **Theme**: Press `Cmd+K Cmd+T` (macOS) or `Ctrl+K Ctrl+T` (Linux/Windows) to open the theme selector
|
|
- **Font**: Search for `buffer_font_family` in Settings
|
|
- **Format on save**: Search for `format_on_save` and set to `on`
|
|
|
|
### 4. Set Up Your Language
|
|
|
|
Zed includes built-in support for many languages. For others, install the extension:
|
|
|
|
1. Open Extensions with `Cmd+Shift+X` (macOS) or `Ctrl+Shift+X` (Linux/Windows)
|
|
2. Search for your language
|
|
3. Click Install
|
|
|
|
See [Languages](./languages.md) for language-specific setup instructions.
|
|
|
|
### 5. Try AI Features
|
|
|
|
Zed includes built-in AI assistance. Open the Agent Panel with `Cmd+Shift+A` (macOS) or `Ctrl+Shift+A` (Linux/Windows) to start a conversation, or use `Cmd+Enter` (macOS) / `Ctrl+Enter` (Linux/Windows) for inline assistance.
|
|
|
|
See [AI Overview](./ai/overview.md) to configure providers and learn what's possible.
|
|
|
|
## Coming from Another Editor?
|
|
|
|
We have dedicated guides for switching from other editors:
|
|
|
|
- [VS Code](./migrate/vs-code.md) — Import settings, map keybindings, find equivalent features
|
|
- [IntelliJ IDEA](./migrate/intellij.md) — Adapt to Zed's approach to navigation and refactoring
|
|
- [PyCharm](./migrate/pycharm.md) — Set up Python development in Zed
|
|
- [WebStorm](./migrate/webstorm.md) — Configure JavaScript/TypeScript workflows
|
|
- [RustRover](./migrate/rustrover.md) — Rust development in Zed
|
|
|
|
You can also enable familiar keybindings:
|
|
|
|
- **Vim**: Enable `vim_mode` in settings. See [Vim Mode](./vim.md).
|
|
- **Helix**: Enable `helix_mode` in settings. See [Helix Mode](./helix.md).
|
|
|
|
## Join the Community
|
|
|
|
Zed is open source. Join us on GitHub or in Discord to contribute code, report bugs, or suggest features.
|
|
|
|
- [Discord](https://discord.com/invite/zedindustries)
|
|
- [GitHub Discussions](https://github.com/zed-industries/zed/discussions)
|
|
- [Zed Reddit](https://www.reddit.com/r/ZedEditor)
|