revealjs-awesoMD-templates

OpenProject layouts and scripts for the slide generator revealjs-awesoMD.

It is based on reveal.js and have the following features.

• Create presentations from markdown files
• Supports metadata in markdown files
• Customizable layouts for slides
• Export presentations as pdf
• Export presentations as static html

Prerequisites

• Node.js (>= 18.0.0)
• pnpm (>= 9.x)

Installation

Clone the repository and install the dependencies:

git clone https://github.com/opf/revealjs-awesoMD-templates.git
cd revealjs-awesoMD-templates
pnpm install

Build

To build the presentation builder run:

pnpm build

Setup Presentations Root Directory

First, copy .env.example file and set presentations root directory path at PRESENTATIONS_ROOT

cp .env.example .env

Serve

To serve the presentation builder run:

pnpm start <markdown-filename>

Your presentation will be served at http://localhost:8000

Create a presentation

To create a presentation, see guidelines here.

Edit a presentation

How to edit a presentation, see guidelines here.

Export a presentation

To export a presentation, see guidelines here.

Run Unit Tests

To run or add unit tests, see guidelines here