CINXE.COM
Home | kramdown
<!doctype html> <html xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <meta name="author" content="Thomas Leitner" /> <meta name="copyright" content="2009-2019 Thomas Leitner" /> <meta name="description" content="kramdown is a fast, pure-Ruby Markdown-superset converter" /> <meta name="keywords" content="ruby, kramdown, markdown, text markup" /> <link href="default-20200422002935.css" type="text/css" rel="stylesheet" media="screen,projection" /> <link href="news.atom" type="application/atom+xml" rel="alternate" /> <title>Home | kramdown</title> </head> <body> <header> <hgroup> <h1 id="logo"><a href="index.html" title="Homepage">kramdown</a></h1> <h2 id="slogan">fast, pure-Ruby Markdown-superset converter</h2> </hgroup> <nav> <ul><li class="webgen-menu-level1 webgen-menu-item-selected"><a href="index.html" hreflang="en">Home</a></li><li class="webgen-menu-level1"><a href="installation.html" hreflang="en">Installation</a></li><li class="webgen-menu-level1"><a href="documentation.html" hreflang="en">Documentation</a></li><li class="webgen-menu-level1"><a href="quickref.html" hreflang="en">Quick Reference</a></li><li class="webgen-menu-level1"><a href="syntax.html" hreflang="en">Syntax</a></li></ul> </nav> </header> <div id="wrapper"> <aside class="banner"> <div itemscope="" itemtype="http://schema.org/SoftwareApplication"> <meta itemprop="applicationCategory" content="Markdown library, Markdown converter" /> <meta itemprop="operatingSystem" content="Linux, Windows, Mac OS X" /> <div itemprop="author" itemscope="" itemtype="http://schema.org/Person"> <meta itemprop="name" content="Thomas Leitner" /> <meta itemprop="email" content="t_leitner@gmx.at" /> </div> <p itemprop="description"><strong itemprop="name">kramdown</strong> (sic, not Kramdown or KramDown, just kramdown) is a <em>free</em> <a href="https://github.com/gettalong/kramdown/blob/master/COPYING" itemprop="license">MIT</a>-licensed <a href="http://www.ruby-lang.org">Ruby</a> library for parsing and converting a superset of Markdown. It is completely written in Ruby, supports standard Markdown (with some minor modifications) and various extensions that have been made popular by the <a href="http://michelf.com/projects/php-markdown/extra/">PHP Markdown Extra</a> package and <a href="http://maruku.rubyforge.org">Maruku</a>.</p> <p>It is probably the fastest pure-Ruby Markdown converter available (January 2019), being about 3x faster than <a href="http://maruku.rubyforge.org">Maruku</a> and about 6.2x faster than <a href="http://ruby.morphball.net/bluefeather/index_en.html">BlueFeather</a>.</p> <p style="text-align: center; font-size: 80%">Version <strong itemprop="softwareVersion">2.5.1</strong> released on <strong itemprop="datePublished">2024-11-18</strong>, <a href="news.html">more news</a></p> </div> <div id="call-to-arms"> Support kramdown development and <a href="https://www.patreon.com/bePatron?u=4908963" class="patreon">become a patron</a>! </div> </aside> <aside> <h2>Support kramdown</h2> <p>If you like kramdown and would like to support it, you are welcome to make a small donation (Patreon or PayPal) -- it will surely be appreciated! Thanks!</p> <div style="text-align: center"> <a href="https://www.patreon.com/bePatron?u=4908963" class="patreon">Become a Patron!</a> <form style="margin-top: 15px" action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top"> <input type="hidden" name="cmd" value="_s-xclick"> <input type="hidden" name="hosted_button_id" value="99HUWKWPMUHWG"> <input type="image" src="//static.gettalong.org/images/paypal_small.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> </form> </div> <h2>Sponsors</h2> <p>GROSSWEBER provides <a href="http://grossweber.com/b/kramdown" target="_blank">software development consulting and training services</a>. <em>We like to work on open source. We use it heavily. We love kramdown!</em></p> </aside> <div id="content"> <h2 id="overview">Overview</h2> <p>If you want to get started with kramdown, have a look at the <a href="installation.html">installation page</a> to see how you can install it on your system. Then look through the <a href="documentation.html">documentation</a> for finding information about how to actually use kramdown and its parsers/converters. The <a href="quickref.html">quick reference</a> provides a overview of the syntax – if you need a more detailed description of the superset of Markdown which kramdown supports the <a href="syntax.html">syntax page</a> is the place to go!</p> <p style="text-align: center"><img src="overview.png" alt="" style="background:transparent" /></p> <h2 id="bugs-forums-mailing-lists">Bugs, Forums, Mailing Lists</h2> <p>If you have found a bug, you should <a href="http://github.com/gettalong/kramdown/issues">report it here</a>. Also, there is the <a href="https://groups.google.com/forum/#!forum/kramdown-users">kramdown-users google group</a> available if you have any questions!</p> <h2 id="thanks">Thanks</h2> <p>kramdown would not be possible without the prior work of many other people. I want to thank everyone involved with making Markdown such a nice markup language and especially the developers of other Markdown implementations because kramdown borrowed many ideas from existing packages.</p> <h2 id="author">Author</h2> <ul> <li>Thomas Leitner</li> <li>e-Mail: <a href="mailto:t_leitner@gmx.at">t_leitner@gmx.at</a></li> </ul> </div> <div style="clear:both"></div> </div> <footer> <div class="float-left"> Copyright © 2009-2019 Thomas Leitner | <a href="https://gettalong.org/legal.html">Legal Notice</a> | <a href="https://gettalong.org/privacy.html">Privacy Policy</a> </div> <div class="float-right">Generated by <a href="https://webgen.gettalong.org">webgen</a></div> </footer> <script src="//static.gettalong.org/MathJax/MathJax.js?config=default.js" type="text/javascript"></script> <script type="text/javascript"> var _paq = _paq || []; _paq.push(["setDoNotTrack", true]); _paq.push(['trackPageView']); _paq.push(['enableLinkTracking']); (function() { var u="//stats.gettalong.org/"; _paq.push(['setTrackerUrl', u+'piwik.php']); _paq.push(['setSiteId', '4']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s); })(); </script> <noscript><p><img src="//stats.gettalong.org/piwik.php?idsite=4&rec=1" style="border:0;" alt="" /></p></noscript> </body> </html>