Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/buluma/ansible-role-revealmd
Install and configure revealmd on your system.
https://github.com/buluma/ansible-role-revealmd
ansible git hacktoberfest html markdown molecule nodejs npm playbook presentation revealmd slides tox
Last synced: about 1 month ago
JSON representation
Install and configure revealmd on your system.
- Host: GitHub
- URL: https://github.com/buluma/ansible-role-revealmd
- Owner: buluma
- License: apache-2.0
- Created: 2022-04-23T15:37:16.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T01:00:24.000Z (5 months ago)
- Last Synced: 2024-07-19T09:24:49.773Z (5 months ago)
- Topics: ansible, git, hacktoberfest, html, markdown, molecule, nodejs, npm, playbook, presentation, revealmd, slides, tox
- Homepage:
- Size: 102 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Ansible role [revealmd](https://galaxy.ansible.com/ui/standalone/roles/buluma/revealmd/documentation)
Install and configure revealmd on your system.
|GitHub|Version|Issues|Pull Requests|Downloads|
|------|-------|------|-------------|---------|
|[](https://github.com/buluma/ansible-role-revealmd/actions/workflows/molecule.yml)|[](https://github.com/buluma/ansible-role-revealmd/releases/)|[](https://github.com/buluma/ansible-role-revealmd/issues/)|[](https://github.com/buluma/ansible-role-revealmd/pulls/)|[](https://galaxy.ansible.com/ui/standalone/roles/buluma/revealmd/documentation)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/buluma/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: buluma.revealmd
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/buluma/ansible-role-revealmd/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: buluma.bootstrap
- role: buluma.epel
- role: buluma.git
- role: buluma.npm
```
Also see a [full explanation and example](https://buluma.github.io/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/buluma/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/buluma/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 | Version |
|-------------|--------|--------|
|[buluma.bootstrap](https://galaxy.ansible.com/buluma/bootstrap)|[](https://github.com/buluma/ansible-role-bootstrap/actions/workflows/molecule.yml)|[](https://github.com/shadowwalker/ansible-role-bootstrap)|
|[buluma.epel](https://galaxy.ansible.com/buluma/epel)|[](https://github.com/buluma/ansible-role-epel/actions/workflows/molecule.yml)|[](https://github.com/shadowwalker/ansible-role-epel)|
|[buluma.git](https://galaxy.ansible.com/buluma/git)|[](https://github.com/buluma/ansible-role-git/actions/workflows/molecule.yml)|[](https://github.com/shadowwalker/ansible-role-git)|
|[buluma.npm](https://galaxy.ansible.com/buluma/npm)|[](https://github.com/buluma/ansible-role-npm/actions/workflows/molecule.yml)|[](https://github.com/shadowwalker/ansible-role-npm)|
|[buluma.service](https://galaxy.ansible.com/buluma/service)|[](https://github.com/buluma/ansible-role-service/actions/workflows/molecule.yml)|[](https://github.com/shadowwalker/ansible-role-service)|
## [Context](#context)
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://buluma.github.io/) 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/buluma):
|container|tags|
|---------|----|
|[EL](https://hub.docker.com/r/buluma/enterpriselinux)|8|
|[Debian](https://hub.docker.com/r/buluma/debian)|bullseye|
|[Fedora](https://hub.docker.com/r/buluma/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/buluma/ansible-role-revealmd/issues)
## [Changelog](#changelog)
[Role History](https://github.com/buluma/ansible-role-revealmd/blob/master/CHANGELOG.md)
## [License](#license)
[Apache-2.0](https://github.com/buluma/ansible-role-revealmd/blob/master/LICENSE)
## [Author Information](#author-information)
[Shadow Walker](https://buluma.github.io/)