zed-101-setup  by jellydn

Editor configuration for Zed, tailored for Vim enthusiasts

Created 1 year ago
1,023 stars

Top 36.6% on SourcePulse

GitHubView on GitHub
Project Summary

This repository provides a comprehensive setup guide for the Zed code editor, targeting developers who want to enhance their workflow with Vim emulation, custom settings, and keybindings. It aims to deliver a seamless and productive coding experience by pre-configuring features like Nerd Fonts, AI assistance, and optimized UI elements.

How It Works

The setup involves applying a detailed settings.json and keymap.json to Zed. The settings.json configures aspects like the Git panel, icon themes, AI providers (Copilot Chat or local Ollama), font choices, indentation guides, and file scan exclusions. The keymap.json defines extensive Vim-like keybindings for navigation, Git operations, buffer management, code actions, and terminal interaction, aiming to replicate familiar Vim workflows within Zed.

Quick Start & Requirements

  • Install Zed: Download from zed.dev.
  • Install Nerd Font: curl -fsSL https://raw.githubusercontent.com/getnf/getnf/main/install.sh | bash
  • Configure Zed: Copy provided settings.json and keymap.json into Zed's configuration directory.
  • Optional AI Setup: Follow Ollama Setup Guide for local AI.

Highlighted Details

  • Full Vim mode emulation with sneak and relative line numbers.
  • Integrated AI assistance with support for Copilot Chat and local Ollama models.
  • Extensive keybindings for Git, buffer management, and code navigation.
  • Pre-configured LSP settings for Tailwind CSS and Python (Ruff, Pyright).
  • Customization for file type highlighting and scan exclusions.

Maintenance & Community

The project is maintained by Huynh Duc Dung (@jellydn) and acknowledges contributors via the all-contributors specification. Support is encouraged via GitHub stars.

Licensing & Compatibility

The repository itself does not specify a license for the provided configuration files. Zed Editor is licensed under the MIT License.

Limitations & Caveats

Some keybindings are marked as "TODO" or have noted issues, such as Zen mode functionality and Git diff navigation, indicating ongoing development or pending upstream fixes in Zed.

Health Check
Last Commit

19 hours ago

Responsiveness

1 day

Pull Requests (30d)
6
Issues (30d)
0
Star History
57 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.