{"repo":"kdheepak/panvimdoc","free":true,"listed":false,"github":"https://github.com/kdheepak/panvimdoc","clone":"git clone https://github.com/kdheepak/panvimdoc.git","description":"Write documentation in pandoc markdown. Generate documentation in vimdoc.","language":"CSS","stars":323,"topics":["markdown","pandoc","neovim","vim","documentation"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"panvimdoc Write documentation in pandoc markdown. Generate documentation in vimdoc. ::: center This software is released under a MIT License. ::: TLDR 1. Add the following to ./.github/workflows/panvimdoc.yml : 2. README.md gets converted to ./doc/${{ github.event.repository.name }}.txt and auto-committed to the repo. Optional : Add the following to ./.github/dependabot.yml to auto update your github action dependencies: Usage Generating vimdoc using GitHub Actions Create an empty doc file: Then add the following to ./.github/workflows/panvimdoc.yml : The only required thing for you to do is to choose a VIMDOC PROJECT NAME HERE appropriately. This is usually the name of the plugin or the documentation file without the .txt extension. For example, the following: will output a file doc/panvimdoc.txt and the vim help tag for it will be panvimdoc using the main branch of the repository. All the other options are optional. However, a description is recommended as suggested in Vim's help-writing . It is recommended to pin to an exact version so you can be confident that no surprises occur for you or your users. See for which version to use. Once you pick a version, you can pin it like so: For an example of how this is used, see one of the following workflows: - kdheepak/panvimdoc: doc/panvimdoc.txt - kdheepak/tabline.nvim: doc/tabline.txt Or see any of the packages here that depend on this action: Generating HTML using GitHub Actions If you are interested in making your vim plugin ","default_branch":null,"files":null,"tree":[],"storefront":"/r/kdheepak","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/kdheepak/panvimdoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}