Skip to content

Commit

Permalink
chore: auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 10, 2023
1 parent cdd0213 commit aec9db5
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions doc/gp.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,23 @@ Table of Contents *gp.nvim-table-of-contents*

1. Goals and Features |gp.nvim-goals-and-features|
2. Install |gp.nvim-install|
- 1. Install the plugin |gp.nvim-install-1.-install-the-plugin-|
- 2. OpenAI API key |gp.nvim-install-2.-openai-api-key-|
- 3. Dependencies |gp.nvim-install-3.-dependencies-|
- 4. Configuration |gp.nvim-install-4.-configuration-|
- 1. Install the plugin |gp.nvim-install-1.-install-the-plugin|
- 2. OpenAI API key |gp.nvim-install-2.-openai-api-key|
- 3. Dependencies |gp.nvim-install-3.-dependencies|
- 4. Configuration |gp.nvim-install-4.-configuration|
3. Usage |gp.nvim-usage|
- Chat commands |gp.nvim-usage-chat-commands-|
- Text/Code operation commands |gp.nvim-usage-text/code-operation-commands-|
- Chat commands |gp.nvim-usage-chat-commands|
- Text/Code commands |gp.nvim-usage-text/code-commands|
- Other commands |gp.nvim-usage-other-commands|
- GpDone autocommand |gp.nvim-usage-gpdone-autocommand-|
- Custom instructions |gp.nvim-usage-custom-instructions-|
- Scripting |gp.nvim-usage-scripting-|
- GpDone autocommand |gp.nvim-usage-gpdone-autocommand|
- Custom instructions |gp.nvim-usage-custom-instructions|
- Scripting |gp.nvim-usage-scripting|
4. Shortcuts |gp.nvim-shortcuts|
- Native |gp.nvim-shortcuts-native|
- Whichkey |gp.nvim-shortcuts-whichkey|
5. Extend functionality |gp.nvim-extend-functionality|


**ChatGPT like sessions, Instructable text/code operations, Speech to text and
Image generation in your favorite editor.**

Expand Down Expand Up @@ -69,7 +71,7 @@ reusing and integrating well with the natural features of (Neo)vim.
2. Install *gp.nvim-install*


1. INSTALL THE PLUGIN *gp.nvim-install-1.-install-the-plugin-*
1. INSTALL THE PLUGIN *gp.nvim-install-1.-install-the-plugin*

Snippets for your preferred package manager:

Expand Down Expand Up @@ -104,7 +106,7 @@ Snippets for your preferred package manager:
<


2. OPENAI API KEY *gp.nvim-install-2.-openai-api-key-*
2. OPENAI API KEY *gp.nvim-install-2.-openai-api-key*

Make sure you have OpenAI API key. Get one here
<https://platform.openai.com/account/api-keys> and use it in the
Expand Down Expand Up @@ -132,7 +134,7 @@ If `openai_api_key` is a table, Gp runs it asynchronously to avoid blocking
Neovim (password managers can take a second or two).


3. DEPENDENCIES *gp.nvim-install-3.-dependencies-*
3. DEPENDENCIES *gp.nvim-install-3.-dependencies*

The core plugin only needs `curl` installed to make calls to OpenAI API and
`grep` for ChatFinder. So Linux, BSD and Mac OS should be covered.
Expand All @@ -147,7 +149,7 @@ recording and processing:
- NixOS: `nix-env -i sox`


4. CONFIGURATION *gp.nvim-install-4.-configuration-*
4. CONFIGURATION *gp.nvim-install-4.-configuration*

Bellow are the default values, but I suggest starting with minimal config
possible (just `openai_api_key` if you don’t have `OPENAI_API_KEY` env set
Expand All @@ -161,7 +163,7 @@ https://github.com/Robitx/gp.nvim/blob/7d802f54fb503f27fc9722656efddb05a533f4cf/
3. Usage *gp.nvim-usage*


CHAT COMMANDS *gp.nvim-usage-chat-commands-*
CHAT COMMANDS *gp.nvim-usage-chat-commands*


:GpChatNew *:GpChatNew*
Expand Down Expand Up @@ -219,7 +221,7 @@ Delete the current chat. By default requires confirmation before delete, which
can be disabled in config using `chat_confirm_delete = false,`.


TEXT/CODE OPERATION COMMANDS *gp.nvim-usage-text/code-operation-commands-*
TEXT/CODE COMMANDS *gp.nvim-usage-text/code-commands*

- *`:GpRewrite`*
`:GpRewrite` Opens a dialog for entering a prompt. After providing prompt instructions into the dialog, the generated response replaces the current line in the normal/insert mode, selected lines in visual mode, or the specified range (for example `:%GpRewrite` would apply the rewrite to the entire buffer).
Expand Down Expand Up @@ -282,7 +284,7 @@ OTHER COMMANDS *gp.nvim-usage-other-commands*
- `:GpInspectPlugin` - inspect GPT prompt plugin object


GPDONE AUTOCOMMAND *gp.nvim-usage-gpdone-autocommand-*
GPDONE AUTOCOMMAND *gp.nvim-usage-gpdone-autocommand*

Commands like `GpRewrite`, `GpAppend` etc. run asynchronously and generate
event `GpDone`, so you can define autocmd (like auto formating) to run when gp
Expand All @@ -300,7 +302,7 @@ finishes:
<


CUSTOM INSTRUCTIONS *gp.nvim-usage-custom-instructions-*
CUSTOM INSTRUCTIONS *gp.nvim-usage-custom-instructions*

By calling `:GpContext` you can make `.gp.md` markdown file in a root of a
repository. Commands such as `:GpRewrite`, `:GpAppend` etc. will respect
Expand All @@ -317,7 +319,7 @@ always listen to system commands). For example:
Here is another example <https://github.com/Robitx/gp.nvim/blob/main/.gp.md>.


SCRIPTING *gp.nvim-usage-scripting-*
SCRIPTING *gp.nvim-usage-scripting*

`GpDone` event + `.gp.md` custom instructions provide a possibility to run
gp.nvim using headless (neo)vim from terminal or shell script. So you can let
Expand Down

0 comments on commit aec9db5

Please sign in to comment.