Ansible Role revealmd

This role helps you install and set up revealmd on your system.

GitHub	Version	Issues	Pull Requests	Downloads

Example Playbook

Here is a simple example from molecule/default/converge.yml, which is tested every time there is a change.

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

  roles:
    - role: buluma.revealmd

You need to prepare your machine first. In continuous integration (CI), this is done using molecule/default/prepare.yml:

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

  roles:
    - role: buluma.bootstrap
    - role: buluma.epel
    - role: buluma.git
    - role: buluma.npm

You can find a full guide with examples on how to use these roles.

Role Variables

The default settings for the variables are in defaults/main.yml:

---
# defaults file for revealmd

# The folder where reveal-md should find presentations.
revealmd_directory: /data

# The specific 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

• Python packages listed in requirements.txt.

Required Roles

These roles are needed to set up your system. You can also prepare your system in other ways.

Requirement	GitHub	Version
buluma.bootstrap
buluma.epel
buluma.git
buluma.npm
buluma.service

Context

This role works well with several other related roles. Check the documentation for those roles for more details.

Here’s a visual of related roles:

Compatibility

This role has been tested on these container images:

You need at least Ansible version 2.12. Tests have been run on:

• The previous version.
• The current version.
• The latest version.

If you encounter any issues, please report them on GitHub

Changelog

You can find the role history here.

License

This project is under the Apache-2.0 License.

Author Information

This role was created by Shadow Walker.