Download & Installation
Since kramdown is written in Ruby, you just need the Ruby interpreter, version 1.8.5, 1.8.6, 1.8.7, 1.9.2 or 1.9.3. There are no other dependencies.
kramdown should work on any platform which supports Ruby. It has been successfully tested on the following platforms:
- Linux with Ruby 1.8.5, 1.8.6, 1.8.7, 1.9.2, 1.9.3 and jruby 1.6.0.
See the platform specific installation notes for more information!
Platform Specific Installation Instructions
There are a variety of Linux distributions out there with different package management systems. So we will focus on instructions for Ubuntu 9.04 here (which should probably also work for any newer Ubuntu version or any recent Debian based distribution).
After running the following commands, kramdown is installed and ready to use:
sudo aptitude install ruby rubygems sudo gem1.8 install kramdown
You will also need to add
export PATH=$PATH:/var/lib/gems/1.8/binto your
~/.bashrcbecause this is the binary path the executable files get installed to.
Mac OS X
Mac OS X Snow Leopard comes with Ruby and Rubygems preinstalled. So installing kramdown is as easy as running:
sudo gem install kramdown
You need to install Ruby first. This can easily be done by using the RubyInstaller - just download
the installation binary and run it. After that open a command shell (select
Start -> Run..., then
cmd and click on
Ok) and type in the following:
gem install kramdown
Generic Installation Instructions
If you are using Rubygems, installing the latest version of kramdown is as simple as executing
gem install kramdown
The latest version of kramdown can always be downloaded as
.zip from its files
section on Rubyforge. After the download the package needs
to be decompressed and then you can install kramdown using the included
$ ruby setup.rb config $ ruby setup.rb setup $ ruby setup.rb install
Using the repository version
kramdown uses git as its versioning system and kramdown’s repository is hosted on GitHub. The repository always contains a clean state of the current development version of kramdown. To check out kramdown use the following command:
git clone git://github.com/gettalong/kramdown.git