Question for lua Plugin devs.

1. lua-language-server

   1 85 3,862 9.2 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.

2. Sevalla

   sevalla.com featured

   Deploy and host your apps and databases, now with $50 credit! Sevalla is the PaaS you have been looking for! Advanced deployment pipelines, usage-based pricing, preview apps, templates, human support by developers, and much more!

   

3. Comment.nvim

   2 63 4,393 7.4 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.

4. mini.nvim

   3 152 7,895 9.7 Lua

   Library of 40+ independent Lua modules improving Neovim 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

5. lemmy-help

   4 11 152 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

6. panvimdoc

   5 14 293 4.2 CSS

   Write documentation in pandoc markdown. Generate documentation in vimdoc.

   

7. ts-vimdoc.nvim

   6 4 16 4.0 Scheme

   

8. mini.doc

   7 1 23 5.5 Lua

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

   

9. InfluxDB

   www.influxdata.com featured

   InfluxDB – Built for High-Performance Time Series Workloads. InfluxDB 3 OSS is now GA. Transform, enrich, and act on time series data directly in the database. Automate critical tasks and eliminate the need to move data externally. Download now.

   

10. nvim-ts-rainbow2

    8 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