{"id":13712983,"url":"https://github.com/rockorager/zzdoc","last_synced_at":"2025-10-30T14:44:23.990Z","repository":{"id":239954030,"uuid":"801085313","full_name":"rockorager/zzdoc","owner":"rockorager","description":"an scdoc compatible manpage compiler for build.zig","archived":false,"fork":false,"pushed_at":"2025-03-05T15:25:32.000Z","size":76,"stargazers_count":19,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T20:08:00.810Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Zig","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/rockorager.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,"zenodo":null}},"created_at":"2024-05-15T15:03:31.000Z","updated_at":"2025-03-05T15:04:22.000Z","dependencies_parsed_at":"2024-05-22T16:47:33.680Z","dependency_job_id":"42cfaa98-d7d5-4ce0-b5c6-e7d4d3aa5e03","html_url":"https://github.com/rockorager/zzdoc","commit_stats":null,"previous_names":["rockorager/zzdoc"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/rockorager/zzdoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockorager%2Fzzdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockorager%2Fzzdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockorager%2Fzzdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockorager%2Fzzdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rockorager","download_url":"https://codeload.github.com/rockorager/zzdoc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockorager%2Fzzdoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281825584,"owners_count":26568294,"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","status":"online","status_checked_at":"2025-10-30T02:00:06.501Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-08-02T23:01:25.539Z","updated_at":"2025-10-30T14:44:23.985Z","avatar_url":"https://github.com/rockorager.png","language":"Zig","funding_links":[],"categories":["Fundamentals"],"sub_categories":["Utility"],"readme":"# zzdoc\n\n`zzdoc` is a 1:1 port of `scdoc`, designed for use in your `build.zig` file. It\nwill compile `scdoc` syntax into roff manpages. It will do so without requiring\n`scdoc` to be installed on the host system. All `scdoc` tests have been ported\nas well, ensuring `zzdoc` produces consistent output.\n\n## Usage\n\n`zzdoc` exposes a generic manpage builder which accepts a `std.Io.Writer` and\n`std.Io.Reader`. This API allows `zzdoc` to be used with a wide variety of\ninputs and outputs.\n\n```zig\nconst std = @import(\"std\");\nconst zzdoc = @import(\"zzdoc\");\n\npub fn main() !void {\n    const allocator = std.testing.allocator;\n    var src = std.fs.cwd().openFile(\"zzdoc.5.scd\", .{});\n    var src_buffer: [1024]u8 = undefined;\n    var src_reader = src.reader(\u0026src_buffer);\n    defer src.close();\n    var dst = std.fs.cwd().createFile(\"zzdoc.5\", .{});\n    var dst_buffer: [1024]u8 = undefined;\n    var dst_writer = dst.writer(\u0026dst_buffer);\n    defer dst.close();\n\n    try zzdoc.generate(allocator, \u0026dst_writer.interface, \u0026src_reader.interface);\n}\n```\n\n`zzdoc` also exposes `build.zig` helpers to make installation of manpages as\nsmooth as possible.\n\n```zig\nconst std = @import(\"std\");\nconst zzdoc = @import(\"zzdoc\");\n\npub fn build(b: *std.Build) void {\n    const target = b.standardTargetOptions(.{});\n    const optimize = b.standardOptimizeOption(.{});\n\n    // All of our *.scd files live in ./docs/\n    var man_step = zzdoc.addManpageStep(b, .{\n        .root_doc_dir = b.path(\"docs/\"),\n    });\n\n    // Add an install step. This helper will install manpages to their\n    // appropriate subdirectory under `.prefix/share/man`\n    const install_step = man_step.addInstallStep(.{});\n    b.default_step.dependOn(\u0026install_step.step);\n}\n```\n\n## License\n\n`zzdoc` is MIT licensed, the same as `scdoc`. Many thanks to Drew DeVault for\ndeveloping `scdoc`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockorager%2Fzzdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frockorager%2Fzzdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockorager%2Fzzdoc/lists"}