Skip to content
/ remark Public
forked from gnab/remark

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

License

Notifications You must be signed in to change notification settings

Costo/remark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

  • Touch support for smart phones and pads, i.e. swipe to navigate slides

Usage

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

  1. Create a boilerplate HTML container:

     <!DOCTYPE html>
     <html>
       <head>
         <title>Title</title>
         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
         <script src="https://github.com/downloads/gnab/remark/remark-0.3.1.min.js" type="text/javascript"></script>
         <style type="text/css" media="screen">
           /* Slideshow styles */
         </style>
       </head>
       <body>
         <textarea id="source">
    
     .center.middle
     # Title
    
     ---
    
     # Agenda
    
     1. Introduction
     2. Deep-dive
     3. ...
    
     ---
    
     # Introduction
    
         </textarea>
         <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

Credits

License

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 50.9%
  • HTML 48.6%
  • Other 0.5%