1810ca0290
Release Notes: - N/A Overview Restructures the documentation navigation to be organized by user goals rather than feature lists. Introduces a new "Working with Code" section and reorganizes existing content into clearer groupings. ### Navigation Changes **New top-level sections:** - **Working with Code** — Groups editing, navigation, and execution features by workflow - **Reference** — Dedicated section for lookup-only content (settings, actions, CLI) - **Coming From...** — Migration guides grouped together **Reorganized sections:** - **Customization** — Renamed from "Configuration," focused on appearance and keybindings - **Account & Privacy** — Consolidated auth, privacy, and telemetry pages New Files | File | Purpose | |------|---------| | `editing-code.md` | Overview page for editing features | | `finding-navigating.md` | Overview page for navigation tools with quick reference | | `running-testing.md` | Overview page for tasks, debugger, and REPL | | `reference/all-settings.md` | Settings reference (moved/renamed) | | `reference/cli.md` | CLI reference (moved) | ### Content Moves | Page | From | To | |------|------|-----| | Snippets | Customization | Working with Code → Editing Code | | Code Completions | (flat) | Working with Code → Editing Code | | Diagnostics | (flat) | Working with Code → Editing Code | | Multibuffers | (flat) | Working with Code → Editing Code | | Command Palette | (flat) | Working with Code → Finding & Navigating | | Outline Panel | (flat) | Working with Code → Finding & Navigating | | Tab Switcher | (flat) | Working with Code → Finding & Navigating | | Tasks | (flat) | Working with Code → Running & Testing | | Debugger | (flat) | Working with Code → Running & Testing | | REPL | (flat) | Working with Code → Running & Testing | | All Settings | Configuration | Reference | | CLI | (various) | Reference --------- Co-authored-by: Marshall Bowers <git@maxdeviant.com> Co-authored-by: Zed Zippy <234243425+zed-zippy[bot]@users.noreply.github.com>
80 lines
3.1 KiB
Markdown
80 lines
3.1 KiB
Markdown
# Getting Started
|
|
|
|
Welcome to Zed! We are excited to have you. Zed is a powerful multiplayer code editor designed to stay out of your way and help you build what's next.
|
|
|
|
This guide gets you from zero to productive in Zed. You'll learn the essential commands, configure your environment, and find your way around.
|
|
|
|
## 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 proudly open source, and we get better with every contribution. 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)
|