Skip to content
A simplistic, in-browser, markdown-driven slideshow tool.
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
spec
src
vendor
.gitignore
Gemfile
Gemfile.lock
HISTORY.md
LICENCE
README.md
Rakefile

README.md

remark

A simplistic, 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

Usage

Visit gnab.github.com/remark for a brief introduction.

  1. Create a boilerplate HTML container:

    <!DOCTYPE html>
    <html>
      <head>
        <title>Title</title>
        <script src="https://github.com/downloads/gnab/remark/remark-0.2.0.min.js" type="text/javascript"></script>
        <style type="text/css" media="screen">
          /* Slideshow styles */
        </style>
      </head>
      <body>
        <pre id="source">
    
    .center.middle
    # Title
    
    ---
    
    # Agenda
    
    1. Introduction
    2. Deep-dive
    3. ...
    
    ---
    
    # Introduction
    
        </pre>
        <div id="slideshow"></div>
      </body>
    </html>
    
  2. Enter you Markdown-formatted slideshow and any styles needed in the assigned areas.

  3. Launch the HTML file in a decent browser and enjoy!

Slideshows created with remark

License

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

Something went wrong with that request. Please try again.