Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Simple helpers to make using sdoc easier.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 sdoc-helpers.gemspec
README.md

sdoc-helpers

Some Rake tasks and hacks to let me easily generate documentation like that found at http://defunkt.github.com/mustache/.

After installing it, put this in your Rakefile:

begin
  require 'sdoc_helpers'
rescue LoadError
  puts "sdoc support not enabled. Please gem install sdoc-helpers."
end

Now (with a clean index) run rake pages:init to create and publish your gh-pages branch.

It'll drop you back on master when it's done. Now in the future just run rake pages to publish sdoc documentation to your gh-pages branch.

Make sure you don't already have a docs/ directory. If you do, this won't work.

If you README (or any files) end in md or markdown they'll get parsed by RDiscount and displayed as Markdown. This gives you a nicely formatted README on GitHub as well as in your sdoc.

Enjoy.

Dependencies

  • rdiscount
  • sdoc

Installation

gem install sdoc-helpers

Author

Chris Wanstrath // chris@ozmm.org

Something went wrong with that request. Please try again.