add documentation for VS Code extension (#327)

Author: joshuadavidthomas

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 ### Added
 
 - Added `pythonpath` configuration option for specifying additional Python import paths
+- Added documentation for VS Code extension
 - Added documentation for Zed extension
 - Added documentation for setting up Sublime Text
 

README.md

@@ -107,6 +107,7 @@ The Django Language Server works with any editor that supports the Language Serv
 
 - [Neovim](clients/nvim/README.md)
 - [Sublime Text](docs/clients/sublime-text.md)
+- [VS Code](docs/clients/vscode.md)
 - [Zed](docs/clients/zed.md)
 
 Got it working in your editor? [Help us add setup instructions!](#testing-and-documenting-editor-setup)

docs/clients/vscode.md

@@ -0,0 +1,21 @@
+---
+title: VS Code
+---
+
+# VS Code
+
+Django Language Server can be used with [VS Code](https://code.visualstudio.com) via the [djls-vscode](https://github.com/joshuadavidthomas/djls-vscode) extension.
+
+## Installation
+
+Install the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=djls.django-language-server):
+
+1. Open the Extensions panel (`Ctrl+Shift+X` / `Cmd+Shift+X`)
+2. Search for "Django Language Server"
+3. Click "Install"
+
+The extension requires Django Language Server (`djls`) to be installed on your system. See [Installation](../index.md#installation) for setup instructions.
+
+## Documentation
+
+For configuration, file associations, troubleshooting, and advanced usage, see the [djls-vscode repository](https://github.com/joshuadavidthomas/djls-vscode).

docs/hooks.py

@@ -51,6 +51,9 @@ def replace_link(match):
         if "clients/nvim/README.md" in path:
             return f"[{text}](clients/neovim.md)"
 
+        if path.startswith(("../", "./")) and (path.endswith(".md") or ".md#" in path):
+            return match.group(0)
+
         clean_path = path.replace("../", "").replace("./", "").lstrip("/")
         return f"[{text}]({repo_url.rstrip('/')}/blob/main/{clean_path})"