README.md

zinit-annex-man

A Zsh-Zinit extension (i.e. an annex) that automatically generates:

• man pages for all plugins and snippets (out of plugin README.md files by using ronn converter),
• code-documentation manpages (by using zshelldoc project).

Man extension is being activated at clone of a plugin and also at update of it and it then generates the manpages. To view them there's a zman command:

# View README.md manpage in the terminal
zman zinit-annex-man
# View the code documentation (via the full plugin name, as demonstrated)
zman -c zdharma-continuum/zinit-annex-man

Screenshots

Main manual (of the project):

Code documentation for the plugin.zsh file (of the project):

Installation

Dependencies

• ruby (+ gem)
• ruby-dev
• tree
• zshelldoc

Simply load as a plugin. This will install the extension within Zinit:

zinit light zdharma-continuum/zinit-annex-man