z-a-man

Introduction#

A Zinit extension 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 z-a-man
# View the code documentation (via the full plugin name, as demonstrated)
zman -c zinit-zsh/z-a-man

Examples#

Main manual (of the project):

README

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

Code documentation

Installation#

Simply load like any other plugin, i.e.: the following command will install the extension within Zinit:

zinit light zinit-zsh/z-a-man