{"id":16992943,"url":"https://github.com/userbradley/actions-documenter","last_synced_at":"2026-05-05T04:06:36.630Z","repository":{"id":188283355,"uuid":"677577377","full_name":"userbradley/actions-documenter","owner":"userbradley","description":"CLI tool to generate documentation for GitHub actions","archived":false,"fork":false,"pushed_at":"2024-01-15T20:21:58.000Z","size":1806,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-27T05:49:40.160Z","etag":null,"topics":["cli","documenter","github-actions","go"],"latest_commit_sha":null,"homepage":"https://userbradley.github.io/actions-documenter/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/userbradley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-12T00:25:52.000Z","updated_at":"2023-08-14T15:21:19.000Z","dependencies_parsed_at":"2023-08-14T18:24:49.024Z","dependency_job_id":null,"html_url":"https://github.com/userbradley/actions-documenter","commit_stats":null,"previous_names":["userbradley/actions-documenter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userbradley%2Factions-documenter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userbradley%2Factions-documenter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userbradley%2Factions-documenter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/userbradley%2Factions-documenter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/userbradley","download_url":"https://codeload.github.com/userbradley/actions-documenter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244907455,"owners_count":20529867,"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":["cli","documenter","github-actions","go"],"created_at":"2024-10-14T03:31:11.827Z","updated_at":"2026-05-05T04:06:31.604Z","avatar_url":"https://github.com/userbradley.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Actions Documenter\n\nThis is a simple CLI tool that allows you to automatically generate **highly opinionated** documentation with \nminimal input from the human\n\n## Installing\n\n```shell\ngit clone git@github.com:userbradley/actions-documenter.git\ngo install\n```\n\n## Setting up the Configuration\n\nCreate a file called `readme.hcl`\n\nIn the file put the below:\n\n```hcl\nversion = \"v1.0.0\"\n\ntitle {\n  enabled = true\n  override = \"\"\n}\n\nquickstart {\n  path = \"docs/quickstart.md\"\n}\n\nexamples {\n  example {\n    enabled = true\n    name    = \"Example 1\"\n    path    = \"docs/example1.md\"\n  }\n\n}\n\nfooter {\n  footer_from = \"footer.md\"\n}\n```\n\n### How to use the version\n\nTo make life easier and not having to update every reference for the verison, you can use `@${{version}}` in the action file\n\n```yaml\n    steps:\n      - uses: userbradley/example-action@${{version}}\n```\n\nWhen this gets rendered out, it will be replaced with what ever `version` is set to\n\nYou should ensure that the `readme.hcl` file is in the same location as the `action.yml` file\n\n### How to add more examples\n\nTo add more examples, just repeat the `example` block like below\n\n```hcl\nexamples {\n  example {\n    enabled = true\n    name    = \"Example 1\"\n    path    = \"docs/example1.md\"\n  }\n  example {\n    enabled = true\n    name    = \"Example 2\"\n    path    = \"docs/example2.md\"\n  }\n}\n```\n\n## Contact\n\nAs per the license, if you want to use this internally please contact me on [legal@breadnet.co.uk](mailto:legal@breadnet.co.uk)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuserbradley%2Factions-documenter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuserbradley%2Factions-documenter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuserbradley%2Factions-documenter/lists"}