Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The Alien device to convert Markdown and Textile files to HTML or PDF

branch: master
README.md

Transmuter Build Status Still Maintained

Transmuter is a command line tool to convert Markdown and Textile files into HTML or PDF, or HTML files to PDF.

It uses pygments.rb, PDFkit, Redcarpet, and RedCloth.

Click here to lend your support to: Open Source Projects and make a donation at www.pledgie.com!

Getting Started

  1. Install the Transmuter gem if you haven't already:

    $ gem install transmuter
    
  2. Transmuter uses pygments.rb, which requires Pygments. You can install Pygments using the Python Easy_Install tool. After installing Easy_Install, you can install Pygments as a Python egg:

      $ sudo easy_install pygments
    

    Pygments is also part of the Debian and Gentoo Linux distributions, and you can install it via the regular package managers. For example, in Ubuntu:

      $ sudo aptitude install python-pygments
    

    You can also install it from source.

  3. Transmuter also uses PDFkit, which requires WKHTMLTOPDF. The PDFKit project on GitHub has excellent installation instructions for WKHTMLTOPDF.

Usage

You can check the help facility:

$ transmute --help

Generate PDF from a Markdown file with the default CSS:

$ transmute file.md

Generate HTML from a Markdown file with the default CSS:

$ transmute file.md -t html

Generate HTML from a Markdown file with custom CSS:

$ transmute file.md -t html -s custom.css

Generate HTML from a Markdown file with several custom CSS files specified by separating the file names with spaces:

$ transmute file.md -t html -s custom1.css custom2.css

Contact

For bugs and feature request, please use Github issues, for other requests, you can contact us:

Don't forget to follow me on Github and Twitter for news and updates.

License

This code is free to use under the terms of the MIT license.

Copyright (c) 2011 TechnoGate <support@technogate.fr>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.