Skip to content

README.md

Latest commit

 

History

History
31 lines (26 loc) · 749 Bytes

README.md

File metadata and controls

31 lines (26 loc) · 749 Bytes

gen-vimdoc.nvim

Generate vimdoc help files from lua/c docstrings, ported from neovim's gen_vimdoc.lua script.

Usage

require('gen').run({
  target_1 = {
    filename = ..., -- path to doc
    files = {
      ..., -- source files
    },
    section_order = {
      ..., -- order or source files
    },
    section_fmt = function(name)
      return name
    end,
    helptag_fmt = function(name)
      return name:lower()
    end,
  },
})

Examples

Plugin dropbar.nvim use this project to generate vimdoc from lua docstrings.