add documentation for Zed editor setup (#318)

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Added
+
+- Added documentation for Zed extension
+
 ## [5.2.3]
 
 ### Added

README.md

@@ -106,6 +106,7 @@ The package provides pre-built wheels with the Rust-based LSP server compiled fo
 The Django Language Server works with any editor that supports the Language Server Protocol (LSP). We currently have setup instructions for:
 
 - [Neovim](clients/nvim/README.md)
+- [Zed](docs/clients/zed.md)
 
 Got it working in your editor? [Help us add setup instructions!](#testing-and-documenting-editor-setup)
 

docs/clients/zed.md

@@ -0,0 +1,30 @@
+---
+title: Zed
+---
+
+# Zed
+
+The Django Language Server can be used with [Zed](https://zed.dev) via the [zed-django](https://github.com/joshuadavidthomas/zed-django) extension.
+
+## Installation
+
+> [!NOTE]
+> The extension is currently awaiting approval for the official Zed extension store.
+>
+> In the meantime, you can install it as a dev extension:
+>
+> 1. Clone the [zed-django](https://github.com/joshuadavidthomas/zed-django) repository locally
+> 2. Open the Extensions panel (`zed: extensions` in the command palette or `ctrl-shift-x`/`cmd-shift-x`)
+> 3. Click "Install Dev Extension" in the upper right corner and select the cloned repo folder
+
+Install the extension from the Zed extensions directory:
+
+1. Open the Extensions panel (`zed: extensions` in the command palette or `ctrl-shift-x`/`cmd-shift-x`)
+2. Search for "Django"
+3. Click "Install"
+
+The extension uses the Django Language Server by default and will automatically download it if not already installed.
+
+## Documentation
+
+For configuration, file associations, and advanced usage, see the [zed-django repository](https://github.com/joshuadavidthomas/zed-django).

docs/hooks.py

@@ -45,6 +45,9 @@ def replace_link(match):
         if path.startswith(("#", "http://", "https://", "./assets/", "assets/")):
             return match.group(0)
 
+        if path.startswith("docs/"):
+            return f"[{text}]({path.removeprefix('docs/')})"
+
         if "clients/nvim/README.md" in path:
             return f"[{text}](clients/neovim.md)"