@@ -12,6 +12,8 @@ Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source cod PDoc depends on Rake, BlueCloth, and treetop, all of which can be obtained through RubyGems: gem install rake BlueCloth treetop + +As an alternative to BlueCloth, you can use [RDiscount](http://github.com/rtomayko/rdiscount/tree/master "rtomayko's rdiscount at master - GitHub"), which is faster than BlueCloth and compatible with Ruby 1.9.1. PDoc will prefer RDiscount if it is found. ## Usage README.markdown @@ -1,4 +1,11 @@ -require "bluecloth" +# Prefer RDiscount because BlueCloth is slow and has problems with Ruby 1.9. +begin + require 'rdiscount' + BlueCloth = RDiscount +rescue LoadError => e + require 'bluecloth' +end + class BlueCloth CodeBlockClassNameRegexp = /(?:\s*lang(?:uage)?:\s*(\w+)\s*\n)(.*)/ def transform_code_blocks( str, rs ) lib/pdoc/generators/html/bluecloth_extension.rb @@ -39,6 +39,8 @@ <pre><code>gem install rake BlueCloth treetop</code></pre> +<p>As an alternative to BlueCloth, you can use <a href="http://github.com/rtomayko/rdiscount/tree/master" title="rtomayko's rdiscount at master - GitHub">RDiscount</a>, which is faster than BlueCloth and compatible with Ruby 1.9.1. PDoc will prefer RDiscount if it is found.</p> + <h2>Usage</h2> <p>For hints on how to run PDoc on the command line, consult the built-in Rake tasks (in <code>Rakefile</code>) and the <code>PDoc::Runner</code> class (in <code>lib/pdoc/runner.rb</code>).</p> website/html/index.html 1ecbd6ebd363dac2b4497ee3849d75358160c64b Andrew Dupont prototype@andrewdupont.net http://github.com/tobie/pdoc/commit/78ee73dfa3693919609f140e8fe02d52ff70e1f6 78ee73dfa3693919609f140e8fe02d52ff70e1f6 2009-03-05T15:24:15-08:00 2009-03-05T15:24:15-08:00 Prefer RDiscount over BlueCloth. f02042c3d6c59038bd357bdf9caab790c7ba9c39 Andrew Dupont prototype@andrewdupont.net