Skip to content

Commit 174cc54

Browse files
MuntasirSZNAntoineGS
authored andcommitted
docs: fix typos and add table of contents
docs: links
1 parent 2378a40 commit 174cc54

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,28 @@ As lua is far more efficient and makes things easier to integrate with modern pl
1111

1212
</details>
1313

14+
## Table Of Contents
15+
16+
<!--toc:start-->
17+
- [Requirements](#requirements)
18+
- [Install](#install)
19+
- [Authentication](#authentication)
20+
- [Authentication with Alternate GitHub Instances](#authentication-with-alternate-github-instances)
21+
- [Setup and Configuration](#setup-and-configuration)
22+
- [panel](#panel)
23+
- [suggestion](#suggestion)
24+
- [filetypes](#filetypes)
25+
- [logger](#logger)
26+
- [copilot_node_command](#copilot_node_command)
27+
- [server_opts_overrides](#server_opts_overrides)
28+
- [workspace_folders](#workspace_folders)
29+
- [root_dir](#root_dir)
30+
- [should_attach](#should_attach)
31+
- [server](#server)
32+
- [Commands](#commands)
33+
- [Integrations](#integrations)
34+
<!--toc:end-->
35+
1436
## Requirements
1537

1638
- Curl
@@ -297,7 +319,7 @@ vim.log = {
297319

298320
- `off`
299321
- `messages` which will output the LSP messages
300-
- `verbose` which adds additonal information to the message.
322+
- `verbose` which adds additional information to the message.
301323

302324
When `trace_lsp_progress` is true, LSP progress messages (`$/progress`) will also be logged.
303325
When `log_lsp_messages` is true, LSP log messages (`window/logMessage`) events will be logged.
@@ -339,7 +361,7 @@ require("copilot").setup {
339361
### workspace_folders
340362

341363
Workspace folders improve Copilot's suggestions.
342-
By default, the root_dir is used as a wokspace_folder.
364+
By default, the root_dir is used as a workspace_folder.
343365

344366
Additional folders can be added through the configuration as such:
345367

@@ -380,7 +402,8 @@ require("copilot").setup {
380402

381403
### server
382404

383-
> [!CAUTION] > `"binary"` mode is still very much experimental, please report any issues you encounter.
405+
> [!CAUTION]
406+
> `"binary"` mode is still very much experimental, please report any issues you encounter.
384407
385408
`type` can be either `"nodejs"` or `"binary"`. The binary version will be downloaded if used.
386409

0 commit comments

Comments
 (0)