Skip to content

Commit 7f17557

Browse files
chore(doc): auto generate docs
1 parent 78b4bc1 commit 7f17557

1 file changed

Lines changed: 36 additions & 20 deletions

File tree

doc/CopilotChat.txt

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,52 @@
33
==============================================================================
44
Table of Contents *CopilotChat-table-of-contents*
55

6-
1. Requirements |CopilotChat-requirements|
6+
1. Overview |CopilotChat-overview|
7+
2. Requirements |CopilotChat-requirements|
78
- Optional Dependencies |CopilotChat-optional-dependencies|
8-
2. Installation |CopilotChat-installation|
9+
3. Installation |CopilotChat-installation|
910
- lazy.nvim |CopilotChat-lazy.nvim|
1011
- vim-plug |CopilotChat-vim-plug|
1112
- Manual |CopilotChat-manual|
12-
3. Features |CopilotChat-features|
13+
4. Features |CopilotChat-features|
1314
- Commands |CopilotChat-commands|
1415
- Key Mappings |CopilotChat-key-mappings|
1516
- Prompts |CopilotChat-prompts|
1617
- Models and Agents |CopilotChat-models-and-agents|
1718
- Contexts |CopilotChat-contexts|
1819
- Selections |CopilotChat-selections|
1920
- Providers |CopilotChat-providers|
20-
4. Configuration |CopilotChat-configuration|
21+
5. Configuration |CopilotChat-configuration|
2122
- Default Configuration |CopilotChat-default-configuration|
2223
- Customizing Buffers |CopilotChat-customizing-buffers|
2324
- Customizing Highlights |CopilotChat-customizing-highlights|
24-
5. API Reference |CopilotChat-api-reference|
25-
6. Examples |CopilotChat-examples|
26-
7. Development |CopilotChat-development|
25+
6. API Reference |CopilotChat-api-reference|
26+
7. Examples |CopilotChat-examples|
27+
8. Development |CopilotChat-development|
2728
- Setup |CopilotChat-setup|
2829
- Contributing |CopilotChat-contributing|
29-
8. Contributors |CopilotChat-contributors|
30-
9. Stargazers |CopilotChat-stargazers|
31-
10. Links |CopilotChat-links|
30+
9. Contributors |CopilotChat-contributors|
31+
10. Stargazers |CopilotChat-stargazers|
32+
11. Links |CopilotChat-links|
3233

3334

3435
==============================================================================
35-
1. Requirements *CopilotChat-requirements*
36+
1. Overview *CopilotChat-overview*
37+
38+
CopilotChat.nvim is a Neovim plugin that brings GitHub Copilot Chat
39+
capabilities directly into your editor. It provides:
40+
41+
- 🤖 Full GitHub Copilot Chat integration with selective context sharing - only sends what you want to share
42+
- 💻 Smart workspace context awareness (buffers, files, git diffs, URLs)
43+
- 🔌 Extensible provider system (supports custom LLM providers like Ollama)
44+
- 📝 Rich chat interface with code completions and diff acceptance
45+
- 🎯 Built-in prompts for common tasks (explain, review, fix, optimize, docs, tests)
46+
- 🔄 Context-aware responses that understand your code and workspace
47+
- ⚡ Efficient token usage with optional tiktoken support
48+
49+
50+
==============================================================================
51+
2. Requirements *CopilotChat-requirements*
3652

3753
- Neovim 0.10.0+ <https://neovim.io/> - Older versions are not officially supported
3854
- curl <https://curl.se/> - Version 8.0.0+ recommended for best compatibility
@@ -58,7 +74,7 @@ OPTIONAL DEPENDENCIES *CopilotChat-optional-dependencies*
5874

5975

6076
==============================================================================
61-
2. Installation *CopilotChat-installation*
77+
3. Installation *CopilotChat-installation*
6278

6379

6480
LAZY.NVIM *CopilotChat-lazy.nvim*
@@ -130,7 +146,7 @@ See @deathbeam <https://github.com/deathbeam> for configuration
130146

131147

132148
==============================================================================
133-
3. Features *CopilotChat-features*
149+
4. Features *CopilotChat-features*
134150

135151

136152
COMMANDS *CopilotChat-commands*
@@ -463,7 +479,7 @@ page
463479

464480

465481
==============================================================================
466-
4. Configuration *CopilotChat-configuration*
482+
5. Configuration *CopilotChat-configuration*
467483

468484

469485
DEFAULT CONFIGURATION *CopilotChat-default-configuration*
@@ -680,7 +696,7 @@ Types of copilot highlights:
680696

681697

682698
==============================================================================
683-
5. API Reference *CopilotChat-api-reference*
699+
6. API Reference *CopilotChat-api-reference*
684700

685701
>lua
686702
local chat = require("CopilotChat")
@@ -730,14 +746,14 @@ Types of copilot highlights:
730746

731747

732748
==============================================================================
733-
6. Examples *CopilotChat-examples*
749+
7. Examples *CopilotChat-examples*
734750

735751
For examples, see the examples wiki page
736752
<https://github.com/CopilotC-Nvim/CopilotChat.nvim/wiki/Examples-and-Tips>.
737753

738754

739755
==============================================================================
740-
7. Development *CopilotChat-development*
756+
8. Development *CopilotChat-development*
741757

742758

743759
SETUP *CopilotChat-setup*
@@ -777,7 +793,7 @@ See CONTRIBUTING.md </CONTRIBUTING.md> for detailed guidelines.
777793

778794

779795
==============================================================================
780-
8. Contributors *CopilotChat-contributors*
796+
9. Contributors *CopilotChat-contributors*
781797

782798
Thanks goes to these wonderful people (emoji key
783799
<https://allcontributors.org/docs/en/emoji-key>):
@@ -788,12 +804,12 @@ Contributions of any kind are welcome!
788804

789805

790806
==============================================================================
791-
9. Stargazers *CopilotChat-stargazers*
807+
10. Stargazers *CopilotChat-stargazers*
792808

793809
<https://starchart.cc/CopilotC-Nvim/CopilotChat.nvim>
794810

795811
==============================================================================
796-
10. Links *CopilotChat-links*
812+
11. Links *CopilotChat-links*
797813

798814
1. *@jellydn*:
799815
2. *@deathbeam*:

0 commit comments

Comments
 (0)