Skip to content

Commit

Permalink
docs: update the configuration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
vyfor committed Dec 22, 2024
1 parent d94b5b8 commit 40ec350
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions wiki/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,16 @@ require('cord').setup {

## ⚙️ Advanced

| Option | Type | Default | Description |
| --------------------------------- | --------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `advanced.plugin.log_level` | `number` | `vim.log.levels.INFO` | Logging level for the plugin |
| `advanced.plugin.autocmds` | `boolean` | `true` | Enable autocmds |
| `advanced.server.pipe_path` | `string \| nil` | `nil` | Custom IPC pipe path |
| `advanced.server.executable_path` | `string \| nil` | `nil` | Custom server executable path |
| `advanced.server.timeout` | `number` | `60000` | Server shutdown timeout (ms) |
| `advanced.cursor_update_mode` | `string` | `'on_move'` | When to update cursor position: `'on_move'`, `'on_hold'`, or `'none'`. See [Cursor Update Mode](#cursor-update-mode) |
| `advanced.variables_in_functions` | `boolean` | `false` | Whether to compute and use variables in functions |
| Option | Type | Default | Description |
| --------------------------------- | --------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `advanced.plugin.log_level` | `number` | `vim.log.levels.INFO` | Logging level for the plugin |
| `advanced.plugin.autocmds` | `boolean` | `true` | Enable autocmds |
| `advanced.server.build` | `string` | `'fetch'` | How to acquire the server executable either if the executable is not found or a manual update is requested: `'fetch'` - fetch from GitHub, `'build'` - build from source, `'none'` - no-op |
| `advanced.server.pipe_path` | `string \| nil` | `nil` | Custom IPC pipe path |
| `advanced.server.executable_path` | `string \| nil` | `nil` | Custom server executable path |
| `advanced.server.timeout` | `number` | `60000` | Server shutdown timeout (ms) |
| `advanced.cursor_update_mode` | `string` | `'on_move'` | When to update cursor position: `'on_move'`, `'on_hold'`, or `'none'`. See [Cursor Update Mode](#cursor-update-mode) |
| `advanced.variables_in_functions` | `boolean` | `false` | Whether to compute and use variables in functions |

---

Expand Down

0 comments on commit 40ec350

Please sign in to comment.