docs: Improve formatter docs. Examples for C/C++ (#20553)

2024-11-13 09:24:50 -05:00
parent 84e47fb80b
commit 3a319e6cbe
3 changed files with 57 additions and 0 deletions
@@ -13,3 +13,29 @@ Clangd out of the box assumes mixed C++/C projects. If you have a C-only project
 CompileFlags:
  Add: [-xc]
 ```
+
+## Formatting
+
+By default Zed will use the `clangd` language server for formatting C code. The Clangd is the same as the `clang-format` CLI tool. To configure this you can add a `.clang-format` file. For example:
+
+```yaml
+---
+BasedOnStyle: GNU
+IndentWidth: 2
+---
+```
+
+See [Clang-Format Style Options](https://clang.llvm.org/docs/ClangFormatStyleOptions.html) for a complete list of options.
+
+You can trigger formatting via {#kb editor::Format} or the `editor: format` action from the command palette or by adding `format_on_save` to your Zed settings:
+
+```json
+  "languages": {
+    "C" {
+      "format_on_save": "on",
+      "tab_size": 2
+    }
+  }
+```
+
+See [Clang-Format Style Options](https://clang.llvm.org/docs/ClangFormatStyleOptions.html) for a complete list of options.