Skip to content

Commit

Permalink
yet more rdoc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
defunkt committed Aug 21, 2007
1 parent 572cc43 commit 3869d8e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You need RedCloth, of course. And Rails.
>> story.description >> story.description
=> "<p>I <em>know</em>!</p>" => "<p>I <em>know</em>!</p>"


=== Different Modes == Different Modes


RedCloth supports different modes, such as :lite_mode. To use a mode on RedCloth supports different modes, such as :lite_mode. To use a mode on
a specific attribute simply pass it in as an options hash after any a specific attribute simply pass it in as an options hash after any
Expand All @@ -75,7 +75,7 @@ in the text boxes / fields as plaintext. Do you have to change all your views?


Hell no. Hell no.


=== form_for == form_for


Are you using form_for? If you are, you don't have to change any code at all. Are you using form_for? If you are, you don't have to change any code at all.


Expand All @@ -85,7 +85,7 @@ Are you using form_for? If you are, you don't have to change any code at all.


You'll see the Textile plaintext in the text field. It Just Works. You'll see the Textile plaintext in the text field. It Just Works.


=== form tags == form tags


If you're being a bit unconvential, no worries. You can still get at your If you're being a bit unconvential, no worries. You can still get at your
raw Textile like so: raw Textile like so:
Expand Down Expand Up @@ -117,5 +117,4 @@ won't need to do this.


Enjoy. Enjoy.


>> Chris Wanstrath * By Chris Wanstrath [ chris[at]ozmm[dot]org ]
=> chris[at]ozmm[dot]org
14 changes: 14 additions & 0 deletions Rakefile
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,14 @@
require 'rake'
require 'rake/testtask'
require 'rake/rdoctask'

desc 'Generate RDoc documentation for the acts_as_textiled plugin.'
Rake::RDocTask.new(:rdoc) do |rdoc|
files = ['README', 'LICENSE', 'lib/**/*.rb']
rdoc.rdoc_files.add(files)
rdoc.main = "README" # page to start on
rdoc.title = "acts_as_textiled"
rdoc.template = File.exists?(t="/Users/chris/ruby/projects/err/rock/template.rb") ? t : "/var/www/rock/template.rb"
rdoc.rdoc_dir = 'doc' # rdoc output folder
rdoc.options << '--inline-source'
end

0 comments on commit 3869d8e

Please sign in to comment.