/remark

A simple, in-browser, markdown-driven slideshow tool.

Primary LanguageJavaScriptMIT LicenseMIT

remark

A simple, in-browser, markdown-driven slideshow tool targeted at people who know their way around HTML and CSS, featuring:

  • Markdown formatting, with smart extensions
  • Automatic syntax highlighting, with optional language hinting
  • Slide scaling, thus similar appearance on all devices / resolutions
  • Touch support for smart phones and pads, i.e. swipe to navigate slides

Check out this remark slideshow for a brief introduction.

Getting Started

It takes only a few, simple steps to get up and running with remark:

  1. Create a HTML file to contain your slideshow (see below)
  2. Open the HTML file in a decent browser
  3. Edit the Markdown and/or CSS styles as needed, save and refresh!

Below is a boilerplate HTML file to get you started:

<!DOCTYPE html>
<html>
  <head>
    <title>Title</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <script src="http://gnab.github.com/remark/downloads/remark-0.4.4.min.js" type="text/javascript">
    </script>
    <style type="text/css" media="screen">
      /* Slideshow styles */
    </style>
  </head>
  <body>
    <textarea id="source">

class: center, middle

# Title

---

# Agenda

1. Introduction
2. Deep-dive
3. ...

---

# Introduction

    </textarea>
    <div id="slideshow"></div>
  </body>
</html>

Moving On

The above boilerplate HTML container will get you up and running. To get the most out of remark, please move on to the the remark wiki for more information.

Real-world remark slideshows

On using remark:

Other interesting stuff:

Credits

License

remark is licensed under the MIT license. See LICENCE for further details.