https://github.com/robertdebock/ansible-role-revealmd
Install and configure revealmd on your system.
https://github.com/robertdebock/ansible-role-revealmd
ansible development git html markdown molecule nodejs npm playbook presentation revealmd slides tox
Last synced: 7 months ago
JSON representation
Install and configure revealmd on your system.
- Host: GitHub
- URL: https://github.com/robertdebock/ansible-role-revealmd
- Owner: robertdebock
- License: apache-2.0
- Created: 2017-11-01T19:39:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T15:30:19.000Z (about 1 year ago)
- Last Synced: 2024-09-13T01:49:24.252Z (about 1 year ago)
- Topics: ansible, development, git, html, markdown, molecule, nodejs, npm, playbook, presentation, revealmd, slides, tox
- Homepage: https://robertdebock.nl/
- Size: 299 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Ansible role revealmd](#revealmd)
Install and configure revealmd on your system.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[](https://github.com/robertdebock/ansible-role-revealmd/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-revealmd)|[](https://galaxy.ansible.com/robertdebock/revealmd)|[](https://github.com/robertdebock/ansible-role-revealmd/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-revealmd/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.
```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: true
roles:
- role: robertdebock.revealmd
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-revealmd/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: robertdebock.bootstrap
- role: robertdebock.epel
- role: robertdebock.git
```
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
## [Role Variables](#role-variables)
The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-revealmd/blob/master/defaults/main.yml):
```yaml
---
# defaults file for revealmd
# The directory where reveal-md should find presentations.
revealmd_directory: /data
# The exact presentation to process
revealmd_presentation: index.md
# The tcp port where reveal-md should listen on.
revealmd_port: 1948
# The theme to use.
# https://github.com/highlightjs/highlight.js/tree/master/src/styles
revealmd_options: --theme black
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-revealmd/blob/master/requirements.txt).
## [State of used roles](#state-of-used-roles)
The following roles are used to prepare a system. You can prepare your system in another way.
| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|
|[robertdebock.epel](https://galaxy.ansible.com/robertdebock/epel)|[](https://github.com/robertdebock/ansible-role-epel/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-epel)|
|[robertdebock.git](https://galaxy.ansible.com/robertdebock/git)|[](https://github.com/robertdebock/ansible-role-git/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-git)|
|[robertdebock.npm](https://galaxy.ansible.com/robertdebock/npm)|[](https://github.com/robertdebock/ansible-role-npm/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-npm)|
|[robertdebock.service](https://galaxy.ansible.com/robertdebock/service)|[](https://github.com/robertdebock/ansible-role-service/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-service)|
## [Dependencies](#dependencies)
Most roles require some kind of preparation, this is done in `molecule/default/prepare.yml`. This role has a "hard" dependency on the following roles:
- {'role': 'robertdebock.npm'}
## [Context](#context)
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
Here is an overview of related roles:
## [Compatibility](#compatibility)
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|container|tags|
|---------|----|
|[Debian](https://hub.docker.com/r/robertdebock/debian)|bullseye|
|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|
The minimum version of Ansible required is 2.12, tests have been done to:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-revealmd/issues).
## [License](#license)
[Apache-2.0](https://github.com/robertdebock/ansible-role-revealmd/blob/master/LICENSE).
## [Author Information](#author-information)
[robertdebock](https://robertdebock.nl/)
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).