{"id":19562449,"url":"https://github.com/quantummaid/documaid","last_synced_at":"2026-06-11T03:31:42.373Z","repository":{"id":54727542,"uuid":"230588078","full_name":"quantummaid/documaid","owner":"quantummaid","description":"DocuMaid is an easy to use plugin to reference code in your documentation and to validate that those links always exist. And you also can insert your current project's version anywhere.","archived":false,"fork":false,"pushed_at":"2023-06-14T22:44:34.000Z","size":571,"stargazers_count":2,"open_issues_count":17,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-26T08:46:24.452Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://quantummaid.de","language":"Kotlin","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/quantummaid.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-12-28T09:26:28.000Z","updated_at":"2021-05-15T10:38:54.000Z","dependencies_parsed_at":"2022-08-14T01:00:47.001Z","dependency_job_id":null,"html_url":"https://github.com/quantummaid/documaid","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/quantummaid/documaid","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantummaid%2Fdocumaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantummaid%2Fdocumaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantummaid%2Fdocumaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantummaid%2Fdocumaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quantummaid","download_url":"https://codeload.github.com/quantummaid/documaid/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantummaid%2Fdocumaid/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34181554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"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-11-11T05:14:33.811Z","updated_at":"2026-06-11T03:31:42.346Z","avatar_url":"https://github.com/quantummaid.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Last Commit](https://img.shields.io/github/last-commit/quantummaid/documaid)](https://github.com/quantummaid/documaid)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.quantummaid/documaid/badge.svg)](https://maven-badges.herokuapp.com/maven-central/de.quantummaid/documaid)\n[![Code Size](https://img.shields.io/github/languages/code-size/quantummaid/documaid)](https://github.com/quantummaid/documaid)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Slack](https://img.shields.io/badge/chat%20on-Slack-brightgreen)](https://join.slack.com/t/quantummaid/shared_invite/zt-cx5qd605-vG10I~WazfgH9WOnXMzl3Q)\n[![Gitter](https://img.shields.io/badge/chat%20on-Gitter-brightgreen)](https://gitter.im/quantum-maid-framework/community)\n[![Twitter](https://img.shields.io/twitter/follow/quantummaid)](https://twitter.com/quantummaid)\n\n\n\u003cimg src=\"documaid_logo.png\" align=\"left\"/\u003e\n\n# DocuMaid\n\nDocuMaid keeps your documentation in sync with your codebase.\n\n## Usage\nTo generate the documentation:\n\n```\nmvn de.quantummaid:documaid:0.9.35:generate\nmvn de.quantummaid:documaid:0.9.35:generate -DskipPaths=docs/Usage.md\n\n```\n\nTo validate whether the current documentation is correct and does not require any changes:\n\n```\nmvn de.quantummaid:documaid:0.9.35:validate\n```\n\n\n## Maven Configuration\n\u003c!---[Plugin](groupId artifactId version goal=generate phase=verify )--\u003e\n```xml\n\u003cplugin\u003e\n    \u003cgroupId\u003ede.quantummaid\u003c/groupId\u003e\n    \u003cartifactId\u003edocumaid\u003c/artifactId\u003e\n    \u003cversion\u003e0.9.45\u003c/version\u003e\n    \u003cexecutions\u003e\n        \u003cexecution\u003e\n            \u003cgoals\u003e\n                \u003cgoal\u003egenerate\u003c/goal\u003e\n            \u003c/goals\u003e\n            \u003cphase\u003everify\u003c/phase\u003e\n        \u003c/execution\u003e\n    \u003c/executions\u003e\n\u003c/plugin\u003e\n```\n\nThe full documentation can be found [here](documentation/Usage.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantummaid%2Fdocumaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquantummaid%2Fdocumaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantummaid%2Fdocumaid/lists"}