New(ish) plugin: ts-vimdoc.nvim, generate vimdoc from your README.md for your plugin using tree-sitter

This page summarizes the projects mentioned and recommended in the original post on /r/neovim

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • ts-vimdoc.nvim

  • It’s not a visual plugin, there is no user interface, it converts .md files to vimdoc format, it’s geared more towards plugin authors to automatically generate their vim help files from the README.md, you can view the automatically generated file here: ts-vimdoc.txt

  • tree-sitter-markdown

    Markdown grammar for tree-sitter

  • The original repo wasn't working since the move from ikatyang/tree-sitter-markdown to the new markdown parser by /u/deinemade/ MDeiml/tree-sitter-markdown so I kept maintaining it as a fork with the absolute basics just so I could generate the vimdoc for fzf-lua.

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • fzf-lua

    Improved fzf.vim written in lua

  • The original repo wasn't working since the move from ikatyang/tree-sitter-markdown to the new markdown parser by /u/deinemade/ MDeiml/tree-sitter-markdown so I kept maintaining it as a fork with the absolute basics just so I could generate the vimdoc for fzf-lua.

  • panvimdoc

    Write documentation in pandoc markdown. Generate documentation in vimdoc.

  • 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.

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts