### Generation of help files from EmmyLua-like annotations
See more details in [Features](#features) and [Documentation](../doc/mini-doc.txt).
---
> [!NOTE]
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-doc) if you want to mention this module.
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
---
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
## Demo
https://user-images.githubusercontent.com/24854248/173044513-755dec35-4f6c-4a51-aa96-5e380f6d744f.mp4
## Features
- Keep documentation next to code by writing EmmyLua-like annotation comments. They will be parsed as is, so formatting should follow built-in guide. However, custom hooks are allowed at many generation stages for more granular management of output help file.
- Generation is done by processing a set of ordered files line by line. Each line can either be considered as a part of documentation block (if it matches certain configurable pattern) or not (considered to be an "afterline" of documentation block). See `MiniDoc.generate()` help for more details.
- Processing is done by using nested data structures (section, block, file, doc) describing certain parts of help file. See `MiniDoc-data-structures` help page for more details.
- Allow flexible customization of output via hook functions.
- Project specific script can be written as plain Lua file with configuratble path. See `MiniDoc.generate()` help for more details.
## Installation
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
There are two branches to install from:
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
Here are code snippets for some common installation methods (use only one):
(Recommended) With vim.pack (on Neovim 0.12 and newer)
**Full library**
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
**Standalone plugin**
Main branch:
```lua
vim.pack.add({ 'https://github.com/nvim-mini/mini.doc' })
```
Stable branch:
```lua
vim.pack.add({
{ src = 'https://github.com/nvim-mini/mini.doc', version = 'stable' },
})
```
With mini.deps (before Neovim 0.12)
**Full library**
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
**Standalone plugin**:
Main branch:
```lua
add('nvim-mini/mini.doc')
```
Stable branch:
```lua
add({ source = 'nvim-mini/mini.doc', checkout = 'stable' })
```
With folke/lazy.nvim
**Full library**
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
**Standalone plugin**
Main branch:
```lua
{ 'nvim-mini/mini.doc', version = false },
```
Stable branch:
```lua
{ 'nvim-mini/mini.doc', version = '*' },
```
**Important**: don't forget to call `require('mini.doc').setup()` to enable its functionality.
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
- Install plugin in other place with shorter path.
## Default config
```lua
-- No need to copy this inside `setup()`. Will be used automatically.
{
-- Lua string pattern to determine if line has documentation annotation.
-- First capture group should describe possible section id. Default value
-- means that annotation line should:
-- - Start with `---` at first column.
-- - Any non-whitespace after `---` will be treated as new section id.
-- - Single whitespace at the start of main text will be ignored.
annotation_pattern = '^%-%-%-(%S*) ?',
-- Identifier of block annotation lines until first captured identifier
default_section_id = '@text',
-- Hooks to be applied at certain stage of document life cycle. Should
-- modify its input in place (and not return new one).
hooks = {
-- Applied to block before anything else
block_pre = --,
-- Applied to section before anything else
section_pre = --,
-- Applied if section has specified captured id
sections = {
['@alias'] = --,
['@class'] = --,
-- For most typical usage see |MiniDoc.afterlines_to_code|
['@eval'] = --,
['@field'] = --,
['@param'] = --,
['@private'] = --,
['@return'] = --,
['@seealso'] = --,
['@signature'] = --,
['@tag'] = --,
['@text'] = --,
['@type'] = --,
['@usage'] = --,
},
-- Applied to section after all previous steps
section_post = --,
-- Applied to block after all previous steps
block_post = --,
-- Applied to file after all previous steps
file = --,
-- Applied to doc after all previous steps
doc = --,
-- Applied before output file is written. Takes lines array as argument.
write_pre = --,
-- Applied after output help file is written. Takes doc as argument.
write_post = --,
},
-- Path (relative to current directory) to script which handles project
-- specific help file generation (like custom input files, hooks, etc.).
script_path = 'scripts/minidoc.lua',
-- Whether to disable showing non-error feedback
silent = false,
}
```
## Similar plugins
- [tjdevries/tree-sitter-lua](https://github.com/tjdevries/tree-sitter-lua)
- [numToStr/lemmy-help](https://github.com/numToStr/lemmy-help) (command line tool)