Skip to content

chiku/presentation

Repository files navigation

Glue to create presentation from markdown files.

The markdown files are concatenated and presented using remark.

The glue script parses the markdown files inside slides directory alphabetically and concatenates them. The concatenated markdown content is inserted into presentation.html.template to give the final output presentation.html. You can view presentation.html in your browser.

Steps

  • Install ruby

  • Clone the repository

git clone https://github.com/chiku/presentation.git
cd presentation
  • Install dependencies using bundler
bundle install
  • Create slides inside slides directory

    • The slides must be in markdown format with file-extension .markdown
    • Each file will become a slide of its own
    • The final slides will be ordered alphabetically based on the file names
  • Run rake to create presentation.html

bundle exec rake
  • Open presentation.html in the browser of your choice OR serve over HTTP.
bundle exec rackup
# visit http://localhost:9292

License

This tool is released under the MIT license. Please refer to LICENSE for more details.

remark is released under MIT license.

About

Simple glue to create presentation from markdown files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published