A tool that converts pandoc markdown to vimdoc format, enabling Vim/Neovim plugin authors to write documentation once and generate help files automatically.
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.
Write documentation in pandoc markdown. Generate documentation in vimdoc.
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Converts pandoc markdown to vimdoc with proper syntax, tags, and links, eliminating manual formatting work as highlighted in the README's motivation for simplicity and unified documentation.
Includes a GitHub Action for automatic documentation generation on push, with configurable options like project name and TOC, demonstrated in the TLDR workflow example.
Can generate both vimdoc and web-friendly HTML from the same markdown source using pandoc templates, as shown in the HTML output section and example workflow.
Offers numerous settings like Tree-sitter highlighting, emoji stripping, and heading level adjustments, allowing tailored output as detailed in the usage configuration.
Requires pandoc v3.0.0+ and potentially Docker for local hooks, adding setup complexity and version management overhead, as admitted in the script usage and pre-commit sections.
Inherits any quirks or gaps in pandoc's markdown parsing, which can affect vimdoc output quality and require workarounds for edge cases not covered by the specification.
Setting up GitHub Actions or pre-commit hooks demands familiarity with CI/CD workflows and YAML configuration, making it less accessible for quick starts.