{"id":20162575,"url":"https://github.com/zdharma-continuum/zinit-annex-man","last_synced_at":"2025-04-10T00:35:55.983Z","repository":{"id":46017941,"uuid":"425100192","full_name":"zdharma-continuum/zinit-annex-man","owner":"zdharma-continuum","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-16T04:44:37.000Z","size":220,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T02:21:51.631Z","etag":null,"topics":["zinit","zinit-annex","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zdharma-continuum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2021-11-05T22:30:33.000Z","updated_at":"2024-12-04T05:30:28.000Z","dependencies_parsed_at":"2024-11-14T00:37:12.373Z","dependency_job_id":null,"html_url":"https://github.com/zdharma-continuum/zinit-annex-man","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-annex-man","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-annex-man/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-annex-man/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zdharma-continuum%2Fzinit-annex-man/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zdharma-continuum","download_url":"https://codeload.github.com/zdharma-continuum/zinit-annex-man/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247749955,"owners_count":20989714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["zinit","zinit-annex","zsh"],"created_at":"2024-11-14T00:25:50.290Z","updated_at":"2025-04-10T00:35:55.968Z","avatar_url":"https://github.com/zdharma-continuum.png","language":"Shell","funding_links":[],"categories":["Plugins"],"sub_categories":["ZSH on Windows"],"readme":"# zinit-annex-man\n\nA Zsh-Zinit extension (i.e. an [annex](https://zdharma-continuum.github.io/zinit/wiki/Annexes/)) that automatically\ngenerates:\n\n- man pages for all plugins and snippets (out of plugin README.md files by using\n  [ronn](https://github.com/rtomayko/ronn) converter),\n- code-documentation manpages (by using [zshelldoc](https://github.com/zdharma-continuum/zshelldoc) project).\n\nMan extension is being activated at clone of a plugin and also at update of it and it then generates the manpages. To\nview them there's a `zman` command:\n\n```zsh\n# View README.md manpage in the terminal\nzman zinit-annex-man\n# View the code documentation (via the full plugin name, as demonstrated)\nzman -c zdharma-continuum/zinit-annex-man\n```\n\n# Screenshots\n\nMain manual (of the project):\n\n![README](https://raw.githubusercontent.com/zdharma-continuum/zinit-annex-man/master/images/zman-readme.png)\n\nCode documentation for the plugin.zsh file (of the project):\n\n![Code documentation](https://raw.githubusercontent.com/zdharma-continuum/zinit-annex-man/master/images/zman-cd.png)\n\n# Installation\n\n## Dependencies\n\n- ruby (+ gem)\n- ruby-dev\n- tree\n- [zshelldoc](https://github.com/zdharma-continuum/zshelldoc)\n\nSimply load as a plugin. This will install the extension within Zinit:\n\n```zsh\nzinit light zdharma-continuum/zinit-annex-man\n```\n\n\u003c!-- vim:set ft=markdown tw=80: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzdharma-continuum%2Fzinit-annex-man","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzdharma-continuum%2Fzinit-annex-man","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzdharma-continuum%2Fzinit-annex-man/lists"}