zinit-annex-man
Zinit extension that generates man pages from plugin READMEs and code documentation for Zsh plugins and snippets.
Overview
zinit-annex-man is a Zinit extension (annex) that automatically generates man pages for Zsh plugins and snippets. It converts plugin README.md files into man pages using ronn and creates code documentation man pages via zshelldoc, enhancing accessibility and usability of Zsh plugin documentation.
Key Features
- Automatic Man Page Generation — Creates man pages from plugin README.md files upon plugin clone or update.
- Code Documentation — Generates man pages for plugin code using zshelldoc for detailed API and function references.
- zman Command — Provides a command-line tool to view generated man pages for both README and code documentation.
- Integration with Zinit — Seamlessly works as a Zinit annex, activating automatically during plugin management.
Philosophy
The project aims to standardize and improve documentation accessibility for Zsh plugins by leveraging existing README files and code comments, making plugin functionality easier to discover and understand.
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.
