README.md in octopress-docs-0.0.11 vs README.md in octopress-docs-0.0.12

- old
+ new

@@ -2,23 +2,26 @@ If you have the Octopress gem installed, run `$ octopress docs` from the root of your Jekyll site, and a website will mount at `http://localhost:4444` with documentation for Octopress and any plugins which support this feature. ## Adding docs to your plugin -Use the code below to automatically add your plugin's Readme, Changelog and any pages in your gem path under `assets/docs`. -If your plugin is built on Octopress Ink, these documentation pages are added automatically. +If your plugin is built on Octopress Ink, these documentation pages are added automatically. If not, use +the code below to automatically add your plugin's Readme, Changelog and any pages in your gem path under `assets/docs`. ```ruby -require 'octopress-docs' -Octopress::Docs.add({ - name: "Your Plugin", - description: "This plugin causes awesomeness", - dir: File.expand_path(File.join(File.dirname(__FILE__), "../../")), - slug: "your-plugin", # optional - source_url: "https://github.com/some/project", # optional - website: "http://example.com", # optional -}) +if defined? Octopress::Docs + Octopress::Docs.add({ + name: "Your Plugin", + description: "This plugin causes awesomeness", + path: File.expand_path(File.join(File.dirname(__FILE__), "../")), # gem root + slug: "your-plugin", # optional + source_url: "https://github.com/some/project", # optional + website: "http://example.com", # optional + }) +end ``` + +It's a bit odd, but the `if defined? Octopress::Docs` allows you to register doc pages if possible, without having to add the octopress-docs gem as a dependency. ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)