gettalong/kramdown


kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.

http://kramdown.gettalong.org

License: Other

Language: Ruby

Keywords: html, kramdown, markdown, pdf, ruby


kramdown

Readme first!

kramdown was originally licensed under the GPL until the 1.0.0 release. However, due to the many requests it is now released under the MIT license and therefore can easily be used in commercial projects, too.

However, if you use kramdown in a commercial setting, please consider contributing back any changes for the benefit of the community and/or becoming a patron - thanks!

Introduction

kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.

The syntax definition for the kramdown syntax can be found in doc/syntax.page (or online at http://kramdown.gettalong.org/syntax.html) and a quick reference is available in doc/quickref.page or online at http://kramdown.gettalong.org/quickref.html.

The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However, due to its flexibility (by creating an internal AST) it supports other input and output formats as well. Here is a list of the supported formats:

  • input formats: kramdown (a Markdown superset), Markdown, GFM, HTML
  • output formats: HTML, kramdown, LaTeX (and therefore PDF), PDF via Prawn

All the documentation on the available input and output formats is available in the doc/ directory and online at http://kramdown.gettalong.org.

Starting from version 1.0.0 kramdown is using a versioning scheme with major, minor and patch parts in the version number where the major number changes on backwards-incompatible changes, the minor number on the introduction of new features and the patch number on everything else.

For information about changes between versions, have a look at http://kramdown.gettalong.org/news.html or the commit history!

Usage

kramdown has a very simple API, so using kramdown is as easy as

require 'kramdown'

Kramdown::Document.new(text).to_html

For detailed information have a look at the API documentation of the Kramdown::Document class.

The full API documentation is available at http://kramdown.gettalong.org/rdoc/, other sites with an API documentation for kramdown probably don't provide the complete documentation!

There are also some third-party libraries that extend the functionality of kramdown -- see the kramdown Wiki at https://github.com/gettalong/kramdown/wiki.

Development

Just clone the git repository as described in doc/installation.page and you are good to go. You probably want to install rake so that you can use the provided rake tasks.

If you want to run the tests, the development dependencies are needed as well as some additional programs like tidy and latex. See the .travis.yml file for more information.

License

MIT - see the COPYING file.

Project Statistics

Sourcerank 20
Repository Size 3.04 MB
Stars 1,286
Forks 206
Watchers 42
Open issues 8
Dependencies 0
Contributors 63
Tags 56
Created
Last updated
Last pushed

Top Contributors See all

Thomas Leitner ccorn Gioele Ashwin Maroli Theodore Pak Arne Brasseur Dan Allen Shuanglei Tao Gleb Mazovetskiy Alex Marandon Brandur Ben Armston Henning Perl Bran Tom Thorogood Jo Hund Dennis Günnewig Parker Moore Lilith River Cédric Boutillier

Packages Referencing this Repo

kramdown
kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and...
Latest release 2.1.0 - Updated - 1.29K stars

Recent Tags See all

REL_2_0_0 January 20, 2019
REL_1_17_0 May 31, 2018
REL_1_16_2 November 29, 2017
REL_1_16_1 November 28, 2017
REL_1_16_0 November 27, 2017
REL_1_15_0 September 08, 2017
REL_1_14_0 June 26, 2017
REL_1_13_2 January 07, 2017
REL_1_13_1 November 25, 2016
REL_1_13_0 November 20, 2016
REL_1_12_0 August 15, 2016
REL_1_11_1 May 01, 2016
REL_1_11_0 May 01, 2016
REL_1_10_0 March 02, 2016
REL_1_9_0 October 02, 2015

Interesting Forks See all

minmb/kramdown
kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and...
Ruby - Other - Updated - 1 stars
wrimle/newstile
kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and...
Ruby - Other - Last pushed - 1 stars
imazen/kramdown
kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and...
Ruby - Other - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-01-31 19:22:23 UTC

Login to resync this repository