Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Docverter

This is the official Docverter Ruby API.

Installation

Add this line to your application's Gemfile:

gem 'docverter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install docverter

Usage

A few example conversions:

Docverter::Conversion.run("markdown", "html", "Some Content")
# => "<html><body><p>Some Content</p></body></html>"

Docverter::Conversion.run do |c|
  c.from    = "markdown"
  c.to      = "html"
  c.content = "Some Content"
  c.stylesheet = "stylesheet.css"
  c.add_other_file "stylesheet.css"
end
# => '<html><head><link rel="stylesheet" media="print" href="stylesheet.css"></head><body><p>Some Content</p></body></html>'

See the documentation for Docverter::Conversion for more details.

Installing the Server

The default endpoint for this library is http://c.docverter.com, a public instance of Docverter server. Installing your own instance on Heroku is a snap. Just follow the directions in the Docverter Server documentation and put this in a Rails initializer (or before your conversions run):

Docverter.base_url = 'http://your-server-app.herokuapp.com'

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

The official Docverter Ruby SDK

Resources

License

Packages

No packages published

Languages