https://github.com/zdharma-continuum/zinit-annex-man
https://github.com/zdharma-continuum/zinit-annex-man
zinit zinit-annex zsh
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zdharma-continuum/zinit-annex-man
- Owner: zdharma-continuum
- License: mit
- Created: 2021-11-05T22:30:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-16T04:44:37.000Z (about 2 years ago)
- Last Synced: 2025-03-24T02:21:51.631Z (3 months ago)
- Topics: zinit, zinit-annex, zsh
- Language: Shell
- Homepage:
- Size: 215 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zinit-annex-man
A Zsh-Zinit extension (i.e. an [annex](https://zdharma-continuum.github.io/zinit/wiki/Annexes/)) that automatically
generates:
- man pages for all plugins and snippets (out of plugin README.md files by using
[ronn](https://github.com/rtomayko/ronn) converter),
- code-documentation manpages (by using [zshelldoc](https://github.com/zdharma-continuum/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:
```zsh
# 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](https://github.com/zdharma-continuum/zshelldoc)
Simply load as a plugin. This will install the extension within Zinit:
```zsh
zinit light zdharma-continuum/zinit-annex-man
```