https://github.com/ruser75/ansible-mddoc
Generate documentation from roles and playbooks
https://github.com/ruser75/ansible-mddoc
ansible ansible-doc ansible-docs ansible-playbook ansible-role documentation markdown
Last synced: 5 months ago
JSON representation
Generate documentation from roles and playbooks
- Host: GitHub
- URL: https://github.com/ruser75/ansible-mddoc
- Owner: rUser75
- License: mit
- Created: 2024-06-14T10:04:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T12:12:32.000Z (over 1 year ago)
- Last Synced: 2025-04-08T05:45:27.260Z (about 1 year ago)
- Topics: ansible, ansible-doc, ansible-docs, ansible-playbook, ansible-role, documentation, markdown
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ansible-mddoc
ansible-mddoc is a package used to auto generate documentation for an ansible role and playbook.
## To install
```
git clone https://github.com/rUser75/ansible-mddoc.git
cd ansible-mddoc
pip3 install .
```
## To run
Call ansible-mddoc passing in the path to the role
```
ansible-mddoc
```
## Documentation
See [here](./docs/index.md) for full documentation.
## Credits
The idea for this project is based on (and includes some code from)
credit to them for their work:
* [ansible-mdgen](https://github.com/murphypetercl/ansible-mdgen) by Peter Murphy
* [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott