
-
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.
-
Nutrient
Nutrient - The #1 PDF SDK Library. Bad PDFs = bad UX. Slow load times, broken annotations, clunky UX frustrates users. Nutrient’s PDF SDKs gives seamless document experiences, fast rendering, annotations, real-time collaboration, 100+ features. Used by 10K+ devs, serving ~half a billion users worldwide. Explore the SDK for free.
-
Comment.nvim
: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.
-
mini.nvim
Library of 40+ independent Lua modules improving overall Neovim (version 0.8 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
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
-
-
-
CodeRabbit
CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.
-
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.
Related posts
-
How do I show Markdown headings in different colours?
-
flirt.nvim - Plugin for working with floating windows (animations, mouse, etc)
-
Testing my config?
-
mini.animate - animate common Neovim actions (cursor movement, scroll, resize, window open/close)
-
Introducing nvim-surround, a plugin for adding/changing/deleting surrounding delimiters