panvimdoc
Write documentation in pandoc markdown. Generate documentation in vimdoc. (by kdheepak)
lemmy-help
Every one needs help, so lemmy-help you! A CLI to generate vim/nvim help doc from emmylua (by numToStr)
panvimdoc | lemmy-help | |
---|---|---|
14 | 11 | |
226 | 142 | |
- | - | |
8.4 | 0.0 | |
29 days ago | 6 months ago | |
CSS | Rust | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
panvimdoc
Posts with mentions or reviews of panvimdoc.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-03-10.
- Hi all, I've made a new release for panvimdoc: v4.0.0
- Show HN: Panvimdoc – Convert pandoc Markdown to vimdoc help
- Question for lua Plugin devs.
- panvimdoc - Write documentation in markdown, generate documentation in vimdoc automatically
-
Vim doc to markdown
Vim Doc to markdown! IDK who's doing that, but people prefer other way around markdown to vimdoc using https://github.com/kdheepak/panvimdoc
-
New(ish) plugin: ts-vimdoc.nvim, generate vimdoc from your README.md for your plugin using tree-sitter
If someone wants similar functionality and they are okay with depending on pandoc instead, I have this repo that make be of relevance: https://github.com/kdheepak/panvimdoc. It also works as a github action, so you can add to a .github/workflows/docs.yml file and forget.
-
Does documentation belong in the README?
If you're using panvimdoc you can put and comments to exclude parts from the generated vimdoc. See my plugin's README.md
- [vent] I really hate that most neovim plugins don't provide docs...
- Feline.nvim version 0.1 released
lemmy-help
Posts with mentions or reviews of lemmy-help.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2023-03-10.
-
Question for lua Plugin devs.
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
-
Plugin devs: type check your lua plugins with lua-language-server and EmmyLua (GitHub action)
When I added some EmmyLua docs to one of my plugins (to generate Vimdoc using lemmy-help), I noticed lua-language-server was giving me diagnostics based on my documentation. This was something I was not getting from linters like luacheck. So I asked myself, "Can I leverage lua-language-server and EmmyLua to statically type check my Lua code?"
-
PSA: Code Blocks can now be highlighted in vimdoc
This will drastically improve the UX of help files. I am adding support for this in lemmy-help here https://github.com/numToStr/lemmy-help/pull/65 and I hope other doc generators can leverage this to provide beautiful help docs :)
-
Are there any good starter templates for writing Neovim plugins?
If you want to provide vim doc, I recommend to use lemmy-help as soon as possible.
-
Side simple project in Rust
Rust is great for parsing text. I created https://github.com/numToStr/lemmy-help to parse emmylua from lua code and convert it into vim help doc. I am also reading https://craftinginterpreters.com/ to expand my parsing knowledge and using Rust as the implementation language.
-
lemmy-help v0.8.0 - Emmylua to vimdoc generator now has full support for emmylua types
I just released lemmy-help v0.8.0 which now has support for all* emmylua types. That means you can use any complex types in you emmylua annotations and it will be parsed correctly and vimdoc will be rendered as expected
-
Vim doc to markdown
And if you are writing lua plugin which have public API, I would recommend writing emmylua and covert that into vimdoc using https://github.com/numToStr/lemmy-help (Self Plug)
-
lemmy-help v0.5.0 | Generate vimdoc from emmylua
multiline ---@field description
-
Generating docs for plugins?
I've just released https://github.com/numToStr/lemmy-help :)
-
lemmy-help | A CLI for generating help docs from emmylua
That's just too much. You can just download the binaries from the releases page https://github.com/numToStr/lemmy-help/releases
What are some alternatives?
When comparing panvimdoc and lemmy-help you can also consider the following projects:
nvim-hlslens - Hlsearch Lens for Neovim
haskell-tools.nvim - Supercharge your Haskell experience in neovim!
orgmode - Orgmode clone written in Lua for Neovim 0.9+.
git-hooks.nix - Seamless integration of https://pre-commit.com git hooks with Nix.
nvim-hclipboard - Hijack your clipboard in Neovim
torqc - The official zeta compiler
nvim-neoclip.lua - Clipboard manager neovim plugin with telescope integration
boilit - create boilerplate structure for neovim plugins
nvim-libmodal - Create new "modes" for Neovim!
videocall-rs - teleconference system written in rust
md2vim - Tool for automatically converting markdown to vimdoc format
tree-sitter-lua - Neovim Tree Sitter Lua Grammar & Library
panvimdoc vs nvim-hlslens
lemmy-help vs haskell-tools.nvim
panvimdoc vs orgmode
lemmy-help vs git-hooks.nix
panvimdoc vs nvim-hclipboard
lemmy-help vs torqc
panvimdoc vs nvim-neoclip.lua
lemmy-help vs boilit
panvimdoc vs nvim-libmodal
lemmy-help vs videocall-rs
panvimdoc vs md2vim
lemmy-help vs tree-sitter-lua