https://github.com/cmsirbu/mkdocs-ansible-collection

MkDocs Plugin that automatically generates pages for Ansible Collections.
https://github.com/cmsirbu/mkdocs-ansible-collection

ansible ansible-collection mkdocs mkdocs-plugin

Last synced: 4 months ago
JSON representation

MkDocs Plugin that automatically generates pages for Ansible Collections.

• Host: GitHub
• URL: https://github.com/cmsirbu/mkdocs-ansible-collection
• Owner: cmsirbu
• License: mit
• Created: 2024-07-27T21:40:25.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-25T16:33:30.000Z (4 months ago)
• Last Synced: 2024-10-01T10:01:45.291Z (4 months ago)
• Topics: ansible, ansible-collection, mkdocs, mkdocs-plugin
• Language: Jinja
• Homepage: https://mkdocs-ansible-collection.readthedocs.io/en/latest/
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDocs Ansible Collection

MkDocs Plugin that automatically generates pages for Ansible Collections. Uses metadata exported by the `ansible-doc` tool.

## Work in Progress

This plugin is under initial development - you can track progress towards the first functional release [here](https://github.com/cmsirbu/mkdocs-ansible-collection/milestone/1).

Its latest functionality can be seen live on the [docs website](https://mkdocs-ansible-collection.readthedocs.io/en/latest/).

## Developing

To set up the development environment, run the following commands in the project root:

```

poetry install

poetry run mkdocs serve

```