{"id":18654489,"url":"https://github.com/z-shell/z-a-man","last_synced_at":"2026-02-12T13:33:37.027Z","repository":{"id":43409176,"uuid":"424171044","full_name":"z-shell/z-a-man","owner":"z-shell","description":"An Annex (i.e an extension) that automatically generates code-documentation man-pages.","archived":false,"fork":false,"pushed_at":"2025-08-26T14:35:43.000Z","size":238,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-04T19:52:06.451Z","etag":null,"topics":["code-documentation","manpage","manuals","zannex","zi","zsdoc"],"latest_commit_sha":null,"homepage":"https://github.com/z-shell/z-a-man","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/z-shell.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-03T09:58:16.000Z","updated_at":"2025-08-17T20:16:52.000Z","dependencies_parsed_at":"2023-12-21T01:30:50.720Z","dependency_job_id":"4dc48e5d-b145-4ab0-9ac3-224b597433fe","html_url":"https://github.com/z-shell/z-a-man","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/z-shell/z-a-man","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fz-a-man","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fz-a-man/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fz-a-man/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fz-a-man/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/z-shell","download_url":"https://codeload.github.com/z-shell/z-a-man/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z-shell%2Fz-a-man/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29367188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T08:51:36.827Z","status":"ssl_error","status_checked_at":"2026-02-12T08:51:26.849Z","response_time":55,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-documentation","manpage","manuals","zannex","zi","zsdoc"],"created_at":"2024-11-07T07:15:34.727Z","updated_at":"2026-02-12T13:33:37.014Z","avatar_url":"https://github.com/z-shell.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"- [Introduction](#introduction)\n- [Screenshots](#screenshots)\n- [Installation](#installation)\n\n## Introduction\n\n\u003e **Note:** \n\u003e - This repository is outdated and may not work properly.\n\u003e - Please consider opening a pull request or an issue, if would like to speed up development.\n\nA [ZI](https://github.com/z-shell/zi) Annex (i.e. an extension) that automatically generates:\n\n- man pages for all plugins and snippets (out of plugin README.md files by\n  using [ronn](https://github.com/rtomayko/ronn) converter),\n- code-documentation manpages (by using\n  [zsdoc](https://github.com/z-shell/zsdoc) project).\n\nMan extension is being activated at clone of a plugin and also at update of it\nand it then generates the manpages. To view them there's a `zman` command:\n\n```zsh\n# View README.md manpage in the terminal\nzman z-a-man\n# View the code documentation (via the full plugin name, as demonstrated)\nzman -c z-shell/z-a-man\n```\n\n## Screenshots\n\nMain manual (of the project):\n\n![README](https://raw.githubusercontent.com/z-shell/z-a-man/main/docs/images/zman-readme.png)\n\nCode documentation for the plugin.zsh file (of the project):\n\n![Code documentation](https://raw.githubusercontent.com/z-shell/z-a-man/main/docs/images/zman-cd.png)\n\n## Installation\n\nSimply load as a plugin. This will install the extension within [ZI](https://github.com/z-shell/zi):\n\n```zsh\nzi light z-shell/z-a-man\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz-shell%2Fz-a-man","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fz-shell%2Fz-a-man","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz-shell%2Fz-a-man/lists"}