Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Jun 8, 2020
1 parent b0b7568 commit dd4f99c
Showing 1 changed file with 42 additions and 25 deletions.
67 changes: 42 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# reveal-md

[reveal.js](http://lab.hakim.se/reveal-js/#/) on steroids! Get beautiful reveal.js presentations from Markdown files.
[reveal.js](https://revealjs.com) on steroids! Get beautiful reveal.js presentations from Markdown files.

## Installation

Expand All @@ -16,6 +16,16 @@ reveal-md path/to/my/slides.md

This starts a local server and opens any Markdown file as a reveal.js presentation in the default browser.

## Reveal.js v4

Thanks to [hugo-vrijswijk](https://github.com/hugo-vrijswijk) we can use
[Reveal.js v4](https://github.com/hakimel/reveal.js/releases). Please test the beta version of reveal-md v4 with your
slides and let us know any issues you might encounter. Install this beta version:

```bash
npm install -g reveal-md@beta
```

## Docker

You can use Docker to run this tool without needing Node.js installed on your machine. Run the public Docker image,
Expand All @@ -30,26 +40,34 @@ The service is now running at [http://localhost:1948](http://localhost:1948).

## Features

- [Markdown](#markdown)
- [Theme](#theme)
- [Highlight Theme](#highlight-theme)
- [Custom Slide Separators](#custom-slide-separators)
- [Custom Slide Attributes](#custom-slide-attributes)
- [reveal-md Options](#reveal-md-options)
- [Reveal.js Options](#revealjs-options)
- [Speaker Notes](#speaker-notes)
- [YAML Front Matter](#yaml-front-matter)
- [Live Reload](#live-reload)
- [Custom Scripts](#custom-scripts)
- [Custom CSS](#custom-css)
- [Custom Favicon](#custom-favicon)
- [Pre-process Markdown](#pre-process-markdown)
- [Print to PDF](#print-to-pdf)
- [Static Website](#static-website)
- [Disable Auto-open Browser](#disable-auto-open-browser)
- [Directory Listing](#directory-listing)
- [Custom Port](#custom-port)
- [Custom Template](#custom-template)
- [Installation](#installation)
- [Usage](#usage)
- [Reveal.js v4](#revealjs-v4)
- [Docker](#docker)
- [Features](#features)
- [Markdown](#markdown)
- [Theme](#theme)
- [Highlight Theme](#highlight-theme)
- [Custom Slide Separators](#custom-slide-separators)
- [Custom Slide Attributes](#custom-slide-attributes)
- [reveal-md Options](#reveal-md-options)
- [Reveal.js Options](#revealjs-options)
- [Speaker Notes](#speaker-notes)
- [YAML Front matter](#yaml-front-matter)
- [Live Reload](#live-reload)
- [Custom Scripts](#custom-scripts)
- [Custom CSS](#custom-css)
- [Custom Favicon](#custom-favicon)
- [Pre-process Markdown](#pre-process-markdown)
- [Print to PDF](#print-to-pdf)
- [Static Website](#static-website)
- [Disable Auto-open Browser](#disable-auto-open-browser)
- [Directory Listing](#directory-listing)
- [Custom Port](#custom-port)
- [Custom Template](#custom-template)
- [Related Projects & Alternatives](#related-projects--alternatives)
- [Thank You](#thank-you)
- [License](#license)

### Markdown

Expand Down Expand Up @@ -152,8 +170,8 @@ Markdown files. They'll be picked up automatically. Example:

### Reveal.js Options

Define Reveal.js [options](https://revealjs.com/config/) in a `reveal.json` file that must be
located at the root directory of the Markdown files. They'll be picked up automatically. Example:
Define Reveal.js [options](https://revealjs.com/config/) in a `reveal.json` file that must be located at the root
directory of the Markdown files. They'll be picked up automatically. Example:

```json
{
Expand All @@ -164,8 +182,7 @@ located at the root directory of the Markdown files. They'll be picked up automa

### Speaker Notes

Use the [speaker notes](https://revealjs.com/speaker-view/) feature by using a line starting with
`Note:`.
Use the [speaker notes](https://revealjs.com/speaker-view/) feature by using a line starting with `Note:`.

### YAML Front matter

Expand Down

0 comments on commit dd4f99c

Please sign in to comment.