Ansible Role RevealMD

This guide helps you install and set up RevealMD on your system.

GitHub	GitLab	Downloads	Version

Example Playbook

Here is an example playbook from molecule/default/converge.yml. It is tested upon each push, pull request, and release.

---
- name: Converge
  hosts: all
  become: true
  gather_facts: true

  roles:
    - role: robertdebock.revealmd

Before running it, the machine must be prepared. In Continuous Integration (CI), this is done with molecule/default/prepare.yml:

---
- name: Prepare
  hosts: all
  become: true
  gather_facts: false

  roles:
    - role: robertdebock.bootstrap
    - role: robertdebock.epel
    - role: robertdebock.git

You can find a full explanation and example on how to use these roles.

Role Variables

Default values for the variables are set in defaults/main.yml:

---
# 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.
revealmd_port: 1948

# The theme to use.
# https://github.com/highlightjs/highlight.js/tree/master/src/styles
revealmd_options: --theme black

Requirements

• Pip packages listed in requirements.txt.

State of Used Roles

The following roles are needed to prepare your system. You can also prepare your system differently.

Requirement	GitHub	GitLab
robertdebock.bootstrap
robertdebock.epel
robertdebock.git
robertdebock.npm
robertdebock.service

Dependencies

Most roles require some setup, which is done in molecule/default/prepare.yml. This role has a strong dependency on:

• {'role': 'robertdebock.npm'}

Context

This role works with many other compatible roles. Check out the documentation of these roles for more details.

Here’s an overview of related roles:

Compatibility

This role has been tested with these container images:

The minimum required version of Ansible is 2.12. Testing has been conducted for:

• The previous version.
• The current version.
• The development version.

If you encounter any issues, please report them on GitHub.

License

This role is licensed under the Apache-2.0.

Author Information

Created by robertdebock.

You can consider sponsoring me.