panvimdoc
A tool that converts pandoc markdown to vimdoc format, enabling Vim/Neovim plugin authors to write documentation once and generate help files automatically.
What is panvimdoc?
panvimdoc is a documentation generator that converts pandoc markdown into vimdoc, the native help format for Vim and Neovim. It simplifies the documentation workflow for plugin authors by allowing them to maintain a single source (like a README) and automatically produce properly formatted vim help files with tags, links, and tables of contents.
Vim and Neovim plugin authors who want to maintain documentation in markdown and automatically generate native vim help files. It is also suitable for developers who need to produce web-friendly HTML documentation from the same source.
Developers choose panvimdoc because it leverages pandoc's extensive format support and Lua filters to produce high-quality vimdoc while keeping the source markdown readable on platforms like GitHub. Its integration with GitHub Actions and pre-commit hooks automates the conversion process, reducing manual effort.
Overview
Write documentation in pandoc markdown. Generate documentation in vimdoc.
Use Cases
Best For
- Automatically generating vimdoc from a README.md file for a Vim/Neovim plugin.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
