https://github.com/z-shell/z-a-man
An Annex (i.e an extension) that automatically generates code-documentation man-pages.
https://github.com/z-shell/z-a-man
code-documentation manpage manuals zannex zi zsdoc
Last synced: 3 months ago
JSON representation
An Annex (i.e an extension) that automatically generates code-documentation man-pages.
- Host: GitHub
- URL: https://github.com/z-shell/z-a-man
- Owner: z-shell
- Created: 2021-11-03T09:58:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T11:57:10.000Z (11 months ago)
- Last Synced: 2025-01-25T11:41:12.369Z (4 months ago)
- Topics: code-documentation, manpage, manuals, zannex, zi, zsdoc
- Language: Shell
- Homepage: https://github.com/z-shell/z-a-man
- Size: 231 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
Awesome Lists containing this project
README
- [Introduction](#introduction)
- [Screenshots](#screenshots)
- [Installation](#installation)
## Introduction
> **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](https://github.com/z-shell/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](https://github.com/rtomayko/ronn) converter),
- code-documentation manpages (by using
[zsdoc](https://github.com/z-shell/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:
```zsh
# 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
```
## Screenshots
Main manual (of the project):
Code documentation for the plugin.zsh file (of the project):
## Installation
Simply load as a plugin. This will install the extension within [ZI](https://github.com/z-shell/zi):
```zsh
zi light z-shell/z-a-man
```