{"id":15017437,"url":"https://github.com/cmsirbu/mkdocs-ansible-collection","last_synced_at":"2026-02-24T20:43:19.018Z","repository":{"id":250500411,"uuid":"834631430","full_name":"cmsirbu/mkdocs-ansible-collection","owner":"cmsirbu","description":"MkDocs Plugin that automatically generates pages for Ansible Collections.","archived":false,"fork":false,"pushed_at":"2025-07-01T13:57:46.000Z","size":169,"stargazers_count":5,"open_issues_count":8,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-20T04:00:44.492Z","etag":null,"topics":["ansible","ansible-collection","mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://mkdocs-ansible-collection.readthedocs.io/en/stable/","language":"Python","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/cmsirbu.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-07-27T21:40:25.000Z","updated_at":"2025-07-03T10:42:23.000Z","dependencies_parsed_at":"2024-09-30T10:00:36.201Z","dependency_job_id":"eb841698-9c03-4c70-9458-46093d555485","html_url":"https://github.com/cmsirbu/mkdocs-ansible-collection","commit_stats":{"total_commits":18,"total_committers":2,"mean_commits":9.0,"dds":0.05555555555555558,"last_synced_commit":"f06fb19e973a50fe05f0ce1a9687216ab5e6b64d"},"previous_names":["cmsirbu/mkdocs-ansible-collection"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cmsirbu/mkdocs-ansible-collection","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmsirbu%2Fmkdocs-ansible-collection","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmsirbu%2Fmkdocs-ansible-collection/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmsirbu%2Fmkdocs-ansible-collection/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmsirbu%2Fmkdocs-ansible-collection/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cmsirbu","download_url":"https://codeload.github.com/cmsirbu/mkdocs-ansible-collection/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cmsirbu%2Fmkdocs-ansible-collection/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278399621,"owners_count":25980330,"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-04T02:00:05.491Z","response_time":63,"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":["ansible","ansible-collection","mkdocs","mkdocs-plugin"],"created_at":"2024-09-24T19:50:27.854Z","updated_at":"2025-10-05T01:25:35.821Z","avatar_url":"https://github.com/cmsirbu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocs Ansible Collection\n\n[MkDocs](https://www.mkdocs.org) Plugin that automatically generates documentation pages for Ansible Collections. Check out the showcase over on the project's [documentation page](https://mkdocs-ansible-collection.readthedocs.io/en/stable/showcase/) and more detailed [User](https://mkdocs-ansible-collection.readthedocs.io/en/stable/user/) and [Developer](https://mkdocs-ansible-collection.readthedocs.io/en/stable/dev/) guides!\n\n## Quick Start\n\n1. Add the `mkdocs-ansible-collection` Python package to your project's docs dependencies. It will also install `ansible-core` to manage collections and get the required metadata.\n\n    ```\n    pip install mkdocs-ansible-collection\n    ```\n\n2. Install any needed collection(s) using `ansible-galaxy collection install example.collection` or point ansible at the correct collection path.\n\n3. Enable the plugin in your project's `mkdocs.yaml` file:\n\n    ```yaml\n    plugins:\n      - \"ansible-collection\":\n          collections:\n            - fqcn: \"example.collection\"\n    ```\n\n4. Add an anchor page to the `nav` section of your project's `mkdocs.yaml` file:\n\n    ```yaml\n    nav:\n      # The anchor is named after the Collection FQCN and it tells mkdocs where\n      # to generate the documentation tree. The following examples show all of\n      # the currently supported combinations:\n      - \"Example Collection\": \"example.collection\" # With an explicit page name\n      - \"Nested Under Another Page\":\n        - \"example.collection\" # Without a custom page name\n    ```\n\nFor more details, check out the [User Guide](https://mkdocs-ansible-collection.readthedocs.io/en/stable/user/) and look at the live example of [this project's docs](https://github.com/cmsirbu/mkdocs-ansible-collection), which showcase how to build and host collection docs on the awesome [Read the Docs](https://about.readthedocs.com/) service!\n\n## Contributions\n\nContributions of all sorts (bug reports, features, documentation etc.) are welcome! Any larger change, please open a new [issue](https://github.com/cmsirbu/mkdocs-ansible-collection/issues) to discuss it first.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcmsirbu%2Fmkdocs-ansible-collection","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcmsirbu%2Fmkdocs-ansible-collection","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcmsirbu%2Fmkdocs-ansible-collection/lists"}