Skip to content
forked from gnab/remark

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

License

Notifications You must be signed in to change notification settings

presidenten/remark

 
 

Repository files navigation

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">
    <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/animate.css/3.5.1/animate.min.css">
    <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'; }
      
      /*
       * Transitions between slides by using Animate.css
       * Find interesting transition animations here!
       * https://daneden.github.io/animate.css/
       */  
       
       /* Browsing forwards transition */
    
       /* Browse to slide */
       .remark-visible.remark-browsing-backwards {
           animation: slideInDown 0.5s forwards;
       }
       /* Browse from slide */
         .remark-fading.remark-browsing-backwards {
           animation: slideOutDown 0.5s forwards;
         }
    
       /* Browsing backwards transition */
    
       /* Browse to slide */ 
         .remark-visible.remark-browsing-forwards {
           animation: slideInUp 0.5s forwards;
         }
    
       /* Browse from slide */ 
       .remark-fading.remark-browsing-forwards {
           animation: slideOutUp 0.5s forwards;
       }
       
       /* disable transitions in presenter mode */
       .remark-presenter-mode * {
         animation: none !important;
       }
       
    </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.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.8%
  • HTML 48.7%
  • Other 0.5%