docs: add info about typst-lsp commands (#2424)

sublimelsp · Feb 19, 2024 · 12b3e93 · 12b3e93
1 parent 7811ef3
commit 12b3e93
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs/src/language_servers.md b/docs/src/language_servers.md
@@ -738,6 +738,7 @@ See [Javascript/TypeScript](#javascripttypescript).
         }
     }
     ```
+
 4. Optional: to enable auto-completions for the relevant situations in Typst files, adjust Sublime's `"auto_complete_selector"` and/or `"auto_complete_triggers"` setting (`Preferences > Settings`); for example
 
     ```jsonc
@@ -751,6 +752,33 @@ See [Javascript/TypeScript](#javascripttypescript).
     }
     ```
 
+5. Optional: to enable some useful commands provided by language server, add the following to the `*.sublime-commands`:
+
+    <!-- how to call: see https://github.com/nvarner/typst-lsp/blob/master/editors/vscode/src/extension.ts -->
+    ```jsonc title="Packages/User/Default.sublime-commands"
+    [
+        // ...
+        {
+            "caption": "typst-lsp - Pin the main file to the currently opened document",
+            "command": "lsp_execute",
+            "args": {
+                "session_name": "typst-lsp",
+                "command_name": "typst-lsp.doPinMain",
+                "command_args": ["${file_uri}"]
+            }
+        },
+        {
+            "caption": "typst-lsp - Unpin the main file",
+            "command": "lsp_execute",
+            "args": {
+                "session_name": "typst-lsp",
+                "command_name": "typst-lsp.doPinMain",
+                "command_args": ["detached"]
+            }
+        },
+    ]
+    ```
+
 ## Vue
 
 There are multiple options: