public
Description: Turn a Markdown File into a Fully Functional Tutorial with an automatic and dynamic Table of Contents
Homepage: http://bogojoker.com/readline/
Clone URL: git://github.com/JosephPecoraro/markdownorial.git
name age message
file .gitignore Sat May 16 20:31:12 -0700 2009 Fixed Table of Contents and improved Usage (Rak... [JosephPecoraro]
file README.markdown Sat May 16 21:26:57 -0700 2009 Added example to the README [JosephPecoraro]
file Rakefile.rb Sat May 16 20:31:12 -0700 2009 Fixed Table of Contents and improved Usage (Rak... [JosephPecoraro]
directory blueprint/ Sat May 16 19:54:33 -0700 2009 Initial Commit [JosephPecoraro]
file config.php Sat May 16 21:11:24 -0700 2009 - Extracted title information to the config.php... [JosephPecoraro]
file content.markdown Sat May 16 19:54:33 -0700 2009 Initial Commit [JosephPecoraro]
directory css/ Thu May 21 11:43:23 -0700 2009 Centered Tables as well. [JosephPecoraro]
file footer.php Sat May 16 19:54:33 -0700 2009 Initial Commit [JosephPecoraro]
directory images/ Sat May 16 19:56:42 -0700 2009 Moved image to the correct directory [JosephPecoraro]
file index.php Tue Oct 27 23:06:26 -0700 2009 Added charset due to recommendation [JosephPecoraro]
directory js/ Tue Oct 27 19:46:22 -0700 2009 Moved to HTML5. Cleaned up whitespace [JosephPecoraro]
directory tools/ Sat May 16 19:54:33 -0700 2009 Initial Commit [JosephPecoraro]
README.markdown

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