GithubHelp home page GithubHelp logo

rubensayshi / remark Goto Github PK

View Code? Open in Web Editor NEW

This project forked from gnab/remark

1.0 2.0 0.0 400 KB

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

Home Page: http://gnab.github.com/remark

License: MIT License

remark's Introduction

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

Check out this remark slideshow for a brief introduction.

Usage

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

  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.5.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!

Check out the remark wiki for more information.

Slideshows created with remark

Credits

License

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

remark's People

Contributors

gnab avatar kimjoar avatar

Stargazers

Ruben de Vries avatar

Watchers

Ruben de Vries avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.