remark travis-ci Bower npm

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

3 years after

remark

Build Status Donate

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
  • Presenter mode, with cloned slideshow view
  • Syntax highlighting, supporting a range of languages
  • 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.

To render your Markdown-based slideshow on the fly, checkout Remarkise.

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 charset="utf-8">
    <style>
      @import url(https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz);
      @import url(https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic);
      @import url(https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic);

      body { font-family: 'Droid Serif'; }
      h1, h2, h3 {
        font-family: 'Yanone Kaffeesatz';
        font-weight: normal;
      }
      .remark-code, .remark-inline-code { font-family: 'Ubuntu Mono'; }
    </style>
  </head>
  <body>
    <textarea id="source">

class: center, middle

# Title

---

# Agenda

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

---

# Introduction

    </textarea>
    <script src="https://gnab.github.io/remark/downloads/remark-latest.min.js">
    </script>
    <script>
      var slideshow = remark.create();
    </script>
  </body>
</html>

Moving On

For more information on using remark, please check out the wiki pages.

Real-world remark slideshows

On using remark:

Other interesting stuff:

Other systems integrating with remark

Contributors

License

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

Related Repositories

remark-lint

remark-lint

Markdown code style linter ...

remark-html

remark-html

Compile Markdown to HTML with remark ...

remark-textr

remark-textr

Remark plugin for Textr — modular tool to make your typography better. ...

remark-vdom

remark-vdom

Compile Markdown to VDOM with remark ...

gulp-remark

gulp-remark

Gulp plugins for Remark ...


Top Contributors

gnab kjbekkelund DanTup freakboy3742 pospi nanoant junderhill gurjeet gureckis torgeir alexander-brett aminb andrewgaul astefanutti venthur bkeepers brenopolanski camerond avdv danielstankiewicz dirkhusemann kud obfusk chadrien hfukada jbeda mathiasbynens michaelsanford jugglinmike mortonfox

Releases

-   v0.7.0 zip tar
-   v0.6.5 zip tar
-   v0.6.4 zip tar
-   v0.6.3 zip tar
-   v0.6.2 zip tar
-   v0.6.1 zip tar
-   v0.6.0 zip tar
-   v0.5.9 zip tar
-   v0.5.8 zip tar
-   v0.5.7 zip tar
-   v0.5.6 zip tar
-   v0.5.5 zip tar
-   v0.5.4 zip tar
-   v0.5.3 zip tar
-   v0.5.2 zip tar
-   v0.5.1 zip tar
-   v0.5.0 zip tar
-   v0.4.6 zip tar
-   v0.4.5 zip tar
-   v0.4.4 zip tar
-   v0.4.3 zip tar
-   v0.4.2 zip tar
-   v.0.4.1 zip tar
-   v0.4.0 zip tar
-   v0.3.6 zip tar
-   v0.3.5 zip tar
-   v0.3.4 zip tar
-   v0.3.3 zip tar
-   v0.3.2 zip tar
-   v0.3.1 zip tar