<commit_before># Markdown To Reveal

Generate a [reveal.js](https://github.com/hakimel/reveal.js) talk from a Markdown file.

## Install

`bundle install --path=.bundle`

## Setup

You'll need to specify the following environment variables. You can do that in
an `.env` at the root of this project.

- `REVEAL_JS_PATH`
  - The absolute path of your reveal.js presentation
  - An `index.html` will be written here.
- `MARKDOWN_PATH`
  - The absolute path where your markdown file is located.
  - An `index.md` will be read from here.

## Markdown Format

The `index.md` is a single file which contains all your slides.

### Slide Separator

Slides are separated by six hyphens (`------`).

### Notes Separator

Each slide can have a speaker notes section too. After your slide content,
add three underscores (`___`), and then add your speaker notes. You'll still
separate the next slide with the hyphens like above.

### Example

Here's an example of a presentation in `index.md`:

```
# First slide of the talk
------


## Second slide of the talk

And some regular text.
-------


## Third Slide

Below, we'll have some speaker notes.
___
This slide has notes too. These work with reveal.js' speaker mode. And they
don't show in the presentation. Notice how the notes are separated from the
slide content by three underscores?
------



## Add some images

![add images too](image_path.jpg)
___
Put the actual image files in your `REVEAL_JS_PATH` so you can see them when
you view your presentation.
```

## Running

`ruby lib/markdown_to_reveal.rb`

## Guard
<commit_msg>Add slide template info to README<commit_after># Markdown To Reveal

Generate a [reveal.js](https://github.com/hakimel/reveal.js) talk from a Markdown file.

## Install

`bundle install --path=.bundle`

## Setup

You'll need to specify the following environment variables. You can do that in
an `.env` at the root of this project.

- `REVEAL_JS_PATH`
  - The absolute path of your reveal.js presentation
  - An `index.html` will be written here.
- `MARKDOWN_PATH`
  - The absolute path where your markdown file is located.
  - An `index.md` will be read from here.

## Markdown Format

The `index.md` is a single file which contains all your slides.

### Slide Separator

Slides are separated by six hyphens (`------`).

### Notes Separator

Each slide can have a speaker notes section too. After your slide content,
add three underscores (`___`), and then add your speaker notes. You'll still
separate the next slide with the hyphens like above.

### Example

Here's an example of a presentation in `index.md`:

```
# First slide of the talk
------


## Second slide of the talk

And some regular text.
-------


## Third Slide

Below, we'll have some speaker notes.
___
This slide has notes too. These work with reveal.js' speaker mode. And they
don't show in the presentation. Notice how the notes are separated from the
slide content by three underscores?
------



## Add some images

![add images too](image_path.jpg)
___
Put the actual image files in your `REVEAL_JS_PATH` so you can see them when
you view your presentation.
```

## Slide Template

There's a `lib/templates/template.html.erb` which will be used as the
scaffolding for the presentation.

Currently, it's configured to generate a talk like my
[ruby_webhooks_intro](https://github.com/kyletolle/ruby_webhooks_intro) talk.

## Running

`ruby lib/markdown_to_reveal.rb`

## Guard

{'fraction_non_alphanumeric': 0.09669880222027462, 'fraction_numerical': 0.0, 'mean_word_length': 3.6332882273342353, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3968473', 'n_tokens_mistral': 1057, 'n_tokens_neox': 1007, 'n_words': 461}