{"id":15019990,"url":"https://github.com/docker/cli-docs-tool","last_synced_at":"2025-05-16T07:04:55.323Z","repository":{"id":37806049,"uuid":"390793785","full_name":"docker/cli-docs-tool","owner":"docker","description":"Utilities to generate (reference) documentation for the docker CLI","archived":false,"fork":false,"pushed_at":"2025-01-12T12:17:53.000Z","size":279,"stargazers_count":24,"open_issues_count":3,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-08T16:08:59.019Z","etag":null,"topics":["docgenerator","docker"],"latest_commit_sha":null,"homepage":"","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/docker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","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-07-29T16:54:22.000Z","updated_at":"2025-02-12T14:39:49.000Z","dependencies_parsed_at":"2023-12-15T11:28:31.884Z","dependency_job_id":"0fbf272f-83c3-41ba-8d7f-d9ba99725ced","html_url":"https://github.com/docker/cli-docs-tool","commit_stats":{"total_commits":127,"total_committers":15,"mean_commits":8.466666666666667,"dds":0.5275590551181102,"last_synced_commit":"53293118a80f36cef8740c257aadba0507bdf572"},"previous_names":["docker/docgen"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fcli-docs-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fcli-docs-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fcli-docs-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fcli-docs-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docker","download_url":"https://codeload.github.com/docker/cli-docs-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485055,"owners_count":22078767,"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":["docgenerator","docker"],"created_at":"2024-09-24T19:54:26.144Z","updated_at":"2025-05-16T07:04:50.297Z","avatar_url":"https://github.com/docker.png","language":"Go","readme":"[![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?logo=go\u0026logoColor=white\u0026style=flat-square)](https://pkg.go.dev/github.com/docker/cli-docs-tool)\n[![Test Status](https://img.shields.io/github/actions/workflow/status/docker/cli-docs-tool/test.yml?branch=main\u0026label=test\u0026logo=github\u0026style=flat-square)](https://github.com/docker/cli-docs-tool/actions?query=workflow%3Atest)\n[![Go Report Card](https://goreportcard.com/badge/github.com/docker/cli-docs-tool)](https://goreportcard.com/report/github.com/docker/cli-docs-tool)\n\n## About\n\nThis is a library containing utilities to generate (reference) documentation\nfor the [`docker` CLI](https://github.com/docker/cli) on [docs.docker.com](https://docs.docker.com/reference/).\n\n## Disclaimer\n\nThis library is intended for use by Docker's CLIs, and is not intended to be a\ngeneral-purpose utility. Various bits are hard-coded or make assumptions that\nare very specific to our use-case. Contributions are welcome, but we will not\naccept contributions to make this a general-purpose module.\n\n## Usage\n\nTo generate the documentation it's recommended to do so using a Go submodule\nin your repository.\n\nWe will use the example of `docker/buildx` and create a Go submodule in a\n`docs` folder (recommended):\n\n```console\n$ mkdir docs\n$ cd ./docs\n$ go mod init github.com/docker/buildx/docs\n$ go get github.com/docker/cli-docs-tool\n```\n\nYour `go.mod` should look like this:\n\n```text\nmodule github.com/docker/buildx/docs\n\ngo 1.16\n\nrequire (\n\tgithub.com/docker/cli-docs-tool v0.0.0\n)\n```\n\nNext, create a file named `main.go` inside that directory containing the\nfollowing Go code from [`example/main.go`](example/main.go).\n\nRunning this example should produce the following output:\n\n```console\n$ go run main.go\nINFO: Generating Markdown for \"docker buildx bake\"\nINFO: Generating Markdown for \"docker buildx build\"\nINFO: Generating Markdown for \"docker buildx create\"\nINFO: Generating Markdown for \"docker buildx du\"\n...\nINFO: Generating YAML for \"docker buildx uninstall\"\nINFO: Generating YAML for \"docker buildx use\"\nINFO: Generating YAML for \"docker buildx version\"\nINFO: Generating YAML for \"docker buildx\"\n```\n\nGenerated docs will be available in the `./docs` folder of the project.\n\n## Contributing\n\nWant to contribute? Awesome! You can find information about contributing to\nthis project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fcli-docs-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocker%2Fcli-docs-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fcli-docs-tool/lists"}