Question for lua Plugin devs.

• lua-language-server

  79 2,988 9.4 Lua

  A language server that offers Lua language support - programmed in Lua

  

Nowadays, people (mostly) autogenerate their help docs with either markdown or emmmylua are their source. You are facing an issue that I faced before with Comment.nvim.

• Comment.nvim

  62 3,520 5.6 Lua

  :brain: :muscle: // Smart and powerful comment plugin for neovim. Supports treesitter, dot repeat, left-right/up-down motions, hooks, and more

Nowadays, people (mostly) autogenerate their help docs with either markdown or emmmylua are their source. You are facing an issue that I faced before with Comment.nvim.

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• mini.nvim

  146 3,857 9.6 Lua

  Library of 35+ independent Lua modules improving overall Neovim (version 0.7 and higher) experience with minimal effort

So let me tell you about my experience! In the stone ages of lua plugins, I was maintaining a markdown file to note down all the APIs but as the plugin was constantly changing, docs were getting out of sync very quickly and it was a royal pain to update them. So, in my case emmylua was the obvious choice for the docs, so I began searching for tools that convert emmylua to vim-help, luckily I found tree-sitter-lua#docgen and mini.doc. But in the end, I decided to write my own tool, and thus lemmy-help was born. Here a help file generated by it

• lemmy-help

  11 141 0.0 Rust

  Every one needs help, so lemmy-help you! A CLI to generate vim/nvim help doc from emmylua

So let me tell you about my experience! In the stone ages of lua plugins, I was maintaining a markdown file to note down all the APIs but as the plugin was constantly changing, docs were getting out of sync very quickly and it was a royal pain to update them. So, in my case emmylua was the obvious choice for the docs, so I began searching for tools that convert emmylua to vim-help, luckily I found tree-sitter-lua#docgen and mini.doc. But in the end, I decided to write my own tool, and thus lemmy-help was born. Here a help file generated by it

• panvimdoc

  14 226 8.3 CSS

  Write documentation in pandoc markdown. Generate documentation in vimdoc.

• ts-vimdoc.nvim

  4 12 4.0 Scheme

• mini.doc

  1 13 5.4 Lua

  Neovim Lua plugin to generate Neovim help files. Part of 'mini.nvim' library.

• WorkOS

  workos.com sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• nvim-ts-rainbow2

  7 - -

If you are afraid of missing something, then I recommend you to put all public symbols in one file. For example, in nvim-ts-rainbow2 the file lua/ts-rainbow re-exports symbols from private modules for public use. Whenever I add a new symbol to the table I know I have to document it.

Suggest a related project