Octopress Docs

TODO: Write a gem description

Installation

Add this line to your application's Gemfile:

gem 'octopress-docs'

And then execute:

$ bundle

Or install it yourself as:

$ gem install octopress-docs

Usage

Automatically add your Readme and Changelog files along with any pages in your gem path under /assets/docs.

begin
  require 'octopress-docs'
  Octopress::Docs.add({
    name:        "Your Plugin",
    slug:        "your-plugin",
    dir:         File.expand_path(File.join(File.dirname(__FILE__), "../../"))
  })
rescue LoadError
end

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request