{"id":13832041,"url":"https://github.com/caddyserver/moduledoc","last_synced_at":"2025-05-05T08:31:59.304Z","repository":{"id":65982088,"uuid":"272492340","full_name":"caddyserver/moduledoc","owner":"caddyserver","description":"Automated JSON docs generation for Caddy modules","archived":false,"fork":false,"pushed_at":"2022-09-20T18:29:46.000Z","size":167,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T19:35:14.491Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caddyserver.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}},"created_at":"2020-06-15T16:40:51.000Z","updated_at":"2024-10-20T16:14:23.000Z","dependencies_parsed_at":"2023-02-19T19:31:02.860Z","dependency_job_id":null,"html_url":"https://github.com/caddyserver/moduledoc","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/caddyserver%2Fmoduledoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caddyserver%2Fmoduledoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caddyserver%2Fmoduledoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caddyserver%2Fmoduledoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caddyserver","download_url":"https://codeload.github.com/caddyserver/moduledoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252466679,"owners_count":21752409,"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":[],"created_at":"2024-08-04T10:01:48.813Z","updated_at":"2025-05-05T08:31:58.926Z","avatar_url":"https://github.com/caddyserver.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"ModuleDoc\n=========\n\n[![godoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/caddyserver/moduledoc)\n\nThis package implements the source analysis core of [Caddy](https://caddyserver.com)'s [module documentation system](https://caddyserver.com/docs/json/). It reads Go code to generate JSON docs -- kind of like godoc, but following JSON tags, and with special integration with Caddy's module architecture.\n\nThis package requires Go to be installed on the machine because it uses [the `packages` package](https://pkg.go.dev/golang.org/x/tools/go/packages) as well as running `go` commands directly. Inputs are fully-qualified package and type names, and outputs are JSON-structured type definitions and documentation. A backing data store is required for amortization.\n\nA front-end can then be built to render the results, for example: both https://caddyserver.com/docs/json/ and https://caddyserver.com/docs/modules are powered by this package.\n\n**Author's disclaimer:** This package comes with no guarantees of stability or correctness. The code is very hand-wavy, and I really had no idea what I was doing at the time, but at least it works! (Mostly.) Always refer to actual source code as authoritative documentation as the output of this package is not always perfect.\n\n_(c) 2019 Matthew Holt_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaddyserver%2Fmoduledoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaddyserver%2Fmoduledoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaddyserver%2Fmoduledoc/lists"}