Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

updating readme

  • Loading branch information...
commit 37f262a8939e3755bcd44a1da17f0ff90145177b 1 parent d0ffab3
William Melody authored
2  .document
... ... @@ -1,4 +1,4 @@
1   -README.rdoc
  1 +README.markdown
2 2 lib/**/*.rb
3 3 bin/*
4 4 features/**/*.feature
34 README.rdoc → README.markdown
Source Rendered
... ... @@ -1,24 +1,31 @@
1   -= PandocRuby
  1 +# PandocRuby
2 2
3   -Wrapper for {http://johnmacfarlane.net/pandoc/ Pandoc}, a Haskell library with command line tools for converting one markup format to another.
  3 +Wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a Haskell library with command line tools for converting one markup format to another.
4 4
5 5 Pandoc can read markdown and (subsets of) reStructuredText, HTML, and LaTeX, and it can write markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man pages, and S5 HTML slide shows
6 6
7   -Assumes pandoc executables are in the path. If not, set their location
8   -with PandocRuby.bin_path = '/path/to/bin'
  7 +## Installation
  8 +
  9 +First, make sure to [install Pandoc](http://johnmacfarlane.net/pandoc/#installing-pandoc).
  10 +
  11 +Next, install PandocRuby from gemcutter.
9 12
10   -Use like so:
  13 + gem install gemcutter
  14 + gem tumble
  15 + gem install pandoc-ruby
  16 +
  17 +## Usage
11 18
12 19 @converter = PandocRuby.new('/some/file.md', :from => :markdown, :to => :rst)
13 20 puts @converter.convert
14 21
15 22 This takes the the Markdown formatted file and converts it to reStructuredText.
16 23
17   -You can also use the <tt>#convert</tt> class method:
  24 +You can also use the `#convert` class method:
18 25
19 26 puts PandocRuby.convert('/some/file.md', :from => :markdown, :to => :html)
20 27
21   -Another also: you get a <tt>#to_s</tt>, for somewhat nicer use in Rails views.
  28 +Another also: you get a `#to_s`, for somewhat nicer use in Rails views.
22 29
23 30 ... helper file ...
24 31 def format(text)
@@ -32,13 +39,16 @@ The default behavior follows the pandoc executable's behavior, converting markdo
32 39
33 40 PandocRuby.new('/some/file.html', 'html2markdown')
34 41
35   -will use Pandoc's <tt>html2markdown</tt> wrapper.
  42 +will use Pandoc's `html2markdown` wrapper.
  43 +
  44 +Assumes pandoc executables are in the path. If not, set their location
  45 +with `PandocRuby.bin_path = '/path/to/bin'`
36 46
37   -For more information on Pandoc, see the {http://johnmacfarlane.net/pandoc/ Pandoc documentation} or run <tt>man pandoc</tt>.
  47 +For more information on Pandoc, see the [Pandoc documentation](http://johnmacfarlane.net/pandoc/) or run `man pandoc`.
38 48
39   -Pretty much everything in the gem was derived directly from {http://github.com/github/albino Albino}.
  49 +Pretty much everything in the gem was derived directly from [Albino](http://github.com/github/albino).
40 50
41   -== Note on Patches/Pull Requests
  51 +## Note on Patches/Pull Requests
42 52
43 53 * Fork the project.
44 54 * Make your feature addition or bug fix.
@@ -49,6 +59,6 @@ Pretty much everything in the gem was derived directly from {http://github.com/g
49 59 bump version in a commit by itself I can ignore when I pull)
50 60 * Send me a pull request. Bonus points for topic branches.
51 61
52   -== Copyright
  62 +## Copyright
53 63
54 64 Copyright (c) 2009 William Melody. See LICENSE for details.
5 pandoc-ruby.gemspec
@@ -14,18 +14,19 @@ Gem::Specification.new do |s|
14 14 s.email = %q{wmelody@gmail.com}
15 15 s.extra_rdoc_files = [
16 16 "LICENSE",
17   - "README"
  17 + "README.markdown"
18 18 ]
19 19 s.files = [
20 20 ".document",
21 21 ".gitignore",
22 22 "LICENSE",
23   - "README",
  23 + "README.markdown",
24 24 "Rakefile",
25 25 "VERSION",
26 26 "lib/pandoc-ruby.rb",
27 27 "pandoc-ruby.gemspec",
28 28 "test/pandoc-ruby_test.rb",
  29 + "test/test.md",
29 30 "test/test_helper.rb"
30 31 ]
31 32 s.homepage = %q{http://github.com/autodata/pandoc-ruby}

0 comments on commit 37f262a

Please sign in to comment.
Something went wrong with that request. Please try again.