Download & Installation
Dependencies
Since kramdown is written in Ruby, you just need the Ruby interpreter, version 2.5 or later. There are no other dependencies.
Compatibility Notes
kramdown should work on any platform which supports Ruby. It has been successfully tested on the following platforms:
- Linux with Ruby 2.5 or later and jruby 9.2.0.0.
See the platform specific installation notes for more information!
Platform Specific Installation Instructions
Linux
You need to make sure that Ruby is installed. If it isn’t, consult the documentation of the Linux distribution you are using on how to install it. For example, in case of Ubuntu 17.10 (this should probably also work for any newer Ubuntu version or any recent Debian based distribution) all you need to do is:
sudo apt-get install ruby
Once you have Ruby installed, you need to execute the following command to install kramdown:
sudo gem install kramdown
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
Windows
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
enter cmd and click on Ok) and type in the following:
gem install kramdown
Generic Installation Instructions
Using Rubygems
If you are using Rubygems, installing the latest version of kramdown is as simple as executing
gem install kramdown
Manual Installation
The latest version of kramdown can always be downloaded as .tar.gz or .zip via the Github
releases page. After the download the package needs to be decompressed and then you can
install kramdown using the included setup.rb installation method:
$ 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