Skip to content

Commit db21158

Browse files
chore(doc): auto generate docs
1 parent 53c088b commit db21158

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

doc/CopilotChat.txt

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
*CopilotChat.txt* For NVIM v0.8.0 Last change: 2025 February 21
1+
*CopilotChat.txt* For NVIM v0.8.0 Last change: 2025 February 22
22

33
==============================================================================
44
Table of Contents *CopilotChat-table-of-contents*
55

66
1. Requirements |CopilotChat-requirements|
7+
- Optional Dependencies |CopilotChat-optional-dependencies|
78
2. Installation |CopilotChat-installation|
89
- lazy.nvim |CopilotChat-lazy.nvim|
910
- vim-plug |CopilotChat-vim-plug|
@@ -34,22 +35,27 @@ Table of Contents *CopilotChat-table-of-contents*
3435
1. Requirements *CopilotChat-requirements*
3536

3637
- Neovim 0.10.0+ <https://neovim.io/> - Older versions are not officially supported
37-
- curl <https://curl.se/> - 8.0.0+ is recommended for best compatibility. Should be installed by default on most systems and also shipped with Neovim
38-
- Copilot chat in the IDE <https://github.com/settings/copilot> setting enabled in GitHub settings
39-
- _Optional_ tiktoken_core <https://github.com/gptlang/lua-tiktoken> - Used for more accurate token counting
40-
- For Arch Linux users, you can install `luajit-tiktoken-bin` <https://aur.archlinux.org/packages/luajit-tiktoken-bin> or `lua51-tiktoken-bin` <https://aur.archlinux.org/packages/lua51-tiktoken-bin> from aur
41-
- Alternatively, install via luarocks: `sudo luarocks install --lua-version 5.1 tiktoken_core`
42-
- Alternatively, download a pre-built binary from lua-tiktoken releases <https://github.com/gptlang/lua-tiktoken/releases>. You can check your Lua PATH in Neovim by doing `:lua print(package.cpath)`. Save the binary as `tiktoken_core.so` in any of the given paths.
43-
- _Optional_ git <https://git-scm.com/> - Used for fetching git diffs for `git` context
44-
- For Arch Linux users, you can install `git` <https://archlinux.org/packages/extra/x86_64/git> from the official repositories
45-
- For other systems, use your package manager to install `git`. For windows use the installer provided from git site
46-
- _Optional_ lynx <https://lynx.invisible-island.net/> - Used for improved fetching of URLs for `url` context
47-
- For Arch Linux users, you can install `lynx` <https://archlinux.org/packages/extra/x86_64/lynx> from the official repositories
48-
- For other systems, use your package manager to install `lynx`. For windows use the installer provided from lynx site
49-
50-
51-
[!WARNING] If you are on neovim < 0.11.0, you also might want to add `noinsert`
52-
and `popup` to your `completeopt` to make the chat completion behave well.
38+
- curl <https://curl.se/> - Version 8.0.0+ recommended for best compatibility
39+
- Copilot chat in the IDE <https://github.com/settings/copilot> enabled in GitHub settings
40+
41+
42+
[!NOTE] For Neovim < 0.11.0, add `noinsert` and `popup` to your `completeopt`
43+
for proper chat completion behavior.
44+
45+
OPTIONAL DEPENDENCIES *CopilotChat-optional-dependencies*
46+
47+
- tiktoken_core <https://github.com/gptlang/lua-tiktoken> - For accurate token
48+
counting
49+
- Arch Linux: Install `luajit-tiktoken-bin` <https://aur.archlinux.org/packages/luajit-tiktoken-bin> or `lua51-tiktoken-bin` <https://aur.archlinux.org/packages/lua51-tiktoken-bin> from AUR
50+
- Via luarocks: `sudo luarocks install --lua-version 5.1 tiktoken_core`
51+
- Manual: Download from lua-tiktoken releases <https://github.com/gptlang/lua-tiktoken/releases> and save as `tiktoken_core.so` in your Lua path
52+
- git <https://git-scm.com/> - For git diff context features
53+
- Arch Linux: Install from official repositories
54+
- Other systems: Use system package manager or official installer
55+
- lynx <https://lynx.invisible-island.net/> - For improved URL context features
56+
- Arch Linux: Install from official repositories
57+
- Other systems: Use system package manager or official installer
58+
5359

5460
==============================================================================
5561
2. Installation *CopilotChat-installation*

0 commit comments

Comments
 (0)