Project

slideshow-md

0.0
No commit activity in last 3 years
No release in over 3 years
slideshow-mdachengscode/slideshowHomepageDocumentationSource CodeBug TrackerWiki
Run a slideshow based off of `remark.js` in your browser.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
7,020
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.1.6
Total releases
4
First release
2017-11-16
Latest release
2018-05-17
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
CSS
Licenses
MIT
Average date of last 50 commits
2017-12-04
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.15
rake
~> 10.0
rspec
~> 3.0

Runtime

erubis
>= 0
sinatra
>= 0
thor
>= 0
 Project Readme

Slideshow

A Ruby-wrapper for the remarkjs library - presents a local markdown file as a slideshow in your browser!

Installation

Install it yourself as:

$ gem install slideshow-md

Usage

To use, simply just run slideshow-md start [slideshow name]. This gem expects a slideshow file in the current directory formatted via markdown file format. Currently we only support a single Markdown file containing the entire slideshow.

An example slideshow is below:

# Title

---

# Agenda

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

---

# Introduction

After starting the application, go to localhost:4567 and your slideshow will be present in your browser!

Development

Fork the repo and create a branch that contains your changes. Make a PR against the master branch here and it'll be merged in if accepted!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/achengscode/slideshow.

License

The gem is available as open source under the terms of the MIT License.