/markdownorial

Turn a Markdown File into a Fully Functional Tutorial with an automatic and dynamic Table of Contents

Primary LanguageJavaScript

markdownorial

Quickly turn any Markdown file into a fully functional tutorial with an awesome table of contents.

Example

My Ruby Readline tutorial is a working example.

Installation

If you haven't yet checked out the source do so with:

shell> git clone git://github.com/JosephPecoraro/markdownorial.git

Then to work with it:

  • edit the content.markdown Markdown file with your content.
  • edit the config.php file to setup the titles you want
  • edit the footer.php file to include the links you want in your footer.
  • when you're set run rake to generate the html file.

Contact Info

Name: Joseph Pecoraro
Blog: http://blog.bogojoker.com
Email: joepeck02@gmail.com