# Neogen - Your annotation toolkit 

Table Of Contents

• Features
• Requirements
• Installation
• Configuration
• Supported Languages
• Usage
• Contributing

Features

• Create annotations with one keybind
• Defaults for multiple languages and annotation conventions
• Extremely customizable and extensible

Requirements

• Install nvim-treesitter

Installation

Use your favorite package manager to install Neogen, e.g:

use { 
    "danymat/neogen", 
    config = function()
        require('neogen').setup {
            enabled = true
        }
    end,
    requires = "nvim-treesitter/nvim-treesitter"
}

Configuration

use { 
    "danymat/neogen", 
    config = function()
        require('neogen').setup {
            enabled = true,             -- required for Neogen to work
            input_after_comment = true, -- automatic jump (with insert mode) on inserted annotation
        }
    end,
    requires = "nvim-treesitter/nvim-treesitter"
}

Supported Languages

There is a list of supported languages and fields, with their annotation style

Language	Annotation conventions	Supported fields
lua	Emmylua
		@param
		@varargs
		@return

Usage

I exposed a command :Neogen to generate the annotations. You can bind it to your keybind of choice, like so:

vim.api.nvim_set_keymap("n", "<Leader>ng", ":Neogen<CR>", {})

If you are inside a function, it'll generate the documentation for you with Emmylua annotation convention

Contributing

A