aidoc.nvim

This is an unofficial implementation of the Mintlify Writer tool for Neovim. It enables the generation of in-code documentation using AI, specifically a chatgpt. Simply by selecting a function or expression, this plugin facilitates the creation of code documentation right at the cursor position.

It's important to note that this plugin may have certain limitations since its functionality relies on the implementation of Mintlify Writer, and not all programming languages may be fully supported.

Please be aware that this plugin will transmit both your function/expression and the entire file to the Mintlify Writer server. While nothing is stored on their end, the server will relay this data to the Chat GPT. Therefore, exercise caution and use it at your own discretion.

Installation

Packer

use{
    'moozd/aidoc.nvim',
    config=function ()
        require('aidoc').setup({
          email = "<your email is optional>",
          width = 65,
          keymap = "<leader>d",
        })
    end,
}

Lazy

{
  'moozd/aidoc.nvim',
   config=function ()
        require('aidoc').setup({
          email = "<your email is optional>",
          width = 65,
          keymap = "<leader>d",
        })
    end,
}

Usage

Select the function/expression and use <leader>d or the key that you passed during the configuration.

Minimal Configuration

require('aidoc').setup({})

Default Configuration

require('aidoc').setup({
    email = "",
    width = 65,
    keymap = "<leader>d",
})

TODO

• Add custom configs
• Add doc style
• Filter unsupported buffer types