z-shell / z-a-man Goto Github PK

• Introduction
• Screenshots
• Installation

Note:

• This repository is outdated and may not work properly.
• Please consider opening a pull request or an issue, if would like to speed up development.

A ZI Annex (i.e. an 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 zsdoc 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 z-shell/z-a-man

Main manual (of the project):

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

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

zi light z-shell/z-a-man