@@ -1,3 +1,5 @@ +* Prefer Maruku over RDiscount. (tobie) + * Fix that autolinking wouldn't recognize numbers in namespaces/method names. * Improve support for "methodized" methods (methods available on both the instance and the class). Introduce `generic_signature` attribute for Documentation::InstanceMethod that shows the alternative signature for the static version of the method. (savetheclocktower) CHANGELOG @@ -9,11 +9,11 @@ Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source cod ## Installation -PDoc depends on Rake, [RDiscount](http://github.com/rtomayko/rdiscount/tree/master "rtomayko's rdiscount at master - GitHub"), and treetop, all of which can be obtained through RubyGems: +PDoc depends on Rake, [Maruku](http://maruku.rubyforge.org/), and treetop, all of which can be obtained through RubyGems: - gem install rake rdiscount treetop + gem install rake maruku treetop -[RDiscount](http://github.com/rtomayko/rdiscount/tree/master "rtomayko's rdiscount at master - GitHub") is a faster alternative to BlueCloth and is compatible with Ruby 1.9.1. +Maruku is a more solid alternative to BlueCloth and is compatible with Ruby 1.9.1. ## Usage README.markdown @@ -1,7 +1,7 @@ HTML_DIR = File.expand_path(File.join(File.dirname(__FILE__), "html")) -# Prefer RDiscount because BlueCloth is slow and has problems with Ruby 1.9. -require 'rdiscount' +# Prefer Maruku because BlueCloth is slow and has problems with Ruby 1.9. +require 'maruku' require File.join(HTML_DIR, "helpers") require File.join(HTML_DIR, "template") require File.join(HTML_DIR, "page") lib/pdoc/generators/html.rb @@ -21,7 +21,7 @@ module PDoc end def htmlize(markdown) - RDiscount.new(markdown, :smart).to_html + Maruku.new(markdown).to_html end # Gah, what an ugly hack. lib/pdoc/generators/html/helpers.rb @@ -35,14 +35,14 @@ <p>Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source code at all; it only parses the comments. This approach, though slightly more verbose, is much better at generating consistent, reliable documentation, and avoids the headaches encountered when documenting highly dynamic languages.</p> - <h2 id="installation">Installation</h2> + <h2>Installation</h2> - <p>PDoc depends on Rake, <a href="http://github.com/rtomayko/rdiscount/tree/master" title="rtomayko's rdiscount at master - GitHub">RDiscount</a>, and treetop, all of which can be obtained through RubyGems:</p> + <p>PDoc depends on Rake, <a href="http://maruku.rubyforge.org/">Maruku</a>, and treetop, all of which can be obtained through RubyGems:</p> - <pre><code>gem install rake rdiscount treetop + <pre><code>gem install rake maruku treetop </code></pre> - <p><a href="http://github.com/rtomayko/rdiscount/tree/master" title="rtomayko's rdiscount at master - GitHub">RDiscount</a> is a faster alternative to BlueCloth and is compatible with Ruby 1.9.1.</p> + <p>Maruku is a more solid alternative to BlueCloth and is compatible with Ruby 1.9.1.</p> <h2>Usage</h2> @@ -65,7 +65,6 @@ <p>The HTML generator (<code>PDoc::Generators::Html</code>) has associated <em>templates</em> (in the <code>templates</code> directory) that accept syntax nodes and echo their metadata onto the page using <a href="http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/index.html" title="erb: Ruby Standard Library Documentation">ERB</a>. Templates are modular, so it’s quite easy to apply a custom “skin” to one’s documentation pages.</p> <p>Furthermore, generators themselves are modular; PDoc can, theoretically, parse once and render to several different targets (HTML, <a href="http://www.docbook.org/" title="DocBook.org">DocBook XML</a>, CHM, PDF, even <a href="http://www.scriptdoc.org/" title="ScriptDoc.org: Dynamic Language Documentation">ScriptDoc</a>.) We hope many such generators will exist in the future.</p> - <div id="twitter_div"> <h2 class="twitter-title">Twitter Updates</h2> website/html/index.html 914a9ea769e1c211184bd2a15d38097d11046bd2 Tobie Langel tobie.langel@gmail.com http://github.com/tobie/pdoc/commit/4c96138a450cca5a46fa7651c0ebe499fa9c3471 4c96138a450cca5a46fa7651c0ebe499fa9c3471

2009-09-02T06:25:44-07:00

Prefer Maruku over RDiscount. ff35e9cc413f98c193db8f0026d949743e797b49 Tobie Langel tobie.langel@gmail.com