https://github.com/gettalong/kramdown

kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
https://github.com/gettalong/kramdown

Keywords

html kramdown markdown pdf ruby

Keywords from Contributors

activejob activerecord mvc rubygems rack rubocop minitest sinatra ruby-gem rspec

Last synced: about 6 hours ago
JSON representation

Repository metadata

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

Host: GitHub
URL: https://github.com/gettalong/kramdown
Owner: gettalong
License: other
Created: 2008-11-30T08:32:47.000Z (over 17 years ago)
Default Branch: master
Last Pushed: 2026-01-31T18:52:28.000Z (about 1 month ago)
Last Synced: 2026-02-24T06:35:08.075Z (8 days ago)
Topics: html, kramdown, markdown, pdf, ruby
Language: Ruby
Homepage: http://kramdown.gettalong.org
Size: 3.28 MB
Stars: 1,752
Watchers: 33
Forks: 280
Open Issues: 16
Releases: 2
Metadata Files:
- Readme: README.md
- License: COPYING
- Authors: AUTHORS

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
sponsor or a
patron - thanks!

Sponsors:

GROSSWEBER provides software
development consulting and training services.

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.

Owner metadata

Name: Thomas Leitner
Login: gettalong
Email: t_leitner@gmx.at
Kind: user
Description:
Website: https://gettalong.org
Location: Austria
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/4104?u=b39ca617e6d440fa5b3488f4beb0a9ebe449c223&v=4
Repositories: 27
Last ynced at: 2025-10-29T04:55:56.976Z
Profile URL: https://github.com/gettalong

GitHub Events

Total

Pull request event: 6
Fork event: 9
Issues event: 39
Watch event: 41
Issue comment event: 73
Push event: 8
Pull request review event: 1
Pull request review comment event: 1
Gollum event: 1
Create event: 2

Last Year

Fork event: 3
Issues event: 13
Watch event: 16
Issue comment event: 26
Push event: 2
Pull request review event: 1
Pull request review comment event: 1
Gollum event: 1

Committers metadata

Last synced: 3 days ago

Total Commits: 1,134
Total Committers: 89
Avg Commits per committer: 12.742
Development Distribution Score (DDS): 0.133

Commits in past year: 4
Committers in past year: 1
Avg Commits per committer in past year: 4.0
Development Distribution Score (DDS) in past year: 0.0

Name	Email	Commits
Thomas Leitner	t**r@g**t	983
Ashwin Maroli	a**i@g**m	21
Christian Cornelssen	c**n@1**e	7
Gioele Barabucci	g**e@s**t	6
Gleb Mazovetskiy	g**b@g**m	5
Ted Pak	p**6@g**m	4
Shuanglei Tao	t**2@g**m	4
Dan Allen	d**n@g**m	4
Arne Brasseur	a**e@a**t	4
Brandur	b**r@m**g	3
Ben Armston	b**n@g**m	3
Alex Marandon	c**t@a**m	3
Carsten Bormann	c**o@t**g	3
Henning Perl	p**l@f**e	3
Bran	m**m@g**m	2
Bryce Willey	B**y@g**m	2
Max Meyer	d**v@f**g	2
Nathanael Jones	n**s@g**m	2
Parker Moore	p**e@g**m	2
Tom Thorogood	m**b@t**k	2
Christopher Jefferson	c**1@s**k	1
Bob Lail	l**l@s**m	1
Ashesh Kumar Singh	u**4@g**m	1
Ashe Connor	a**e@k**e	1
Antoine Cotten	h**o@a**m	1
Andrew	a**e@g**m	1
Cédric Boutillier	c**r@g**m	1
Damien Pollet	d**t@g**m	1
Daniel Bair	d**l@d**m	1
David Rodríguez	d**z@r**t	1
and 59 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 26 days ago

Total issues: 119
Total pull requests: 39
Average time to close issues: 8 months
Average time to close pull requests: 10 months
Total issue authors: 103
Total pull request authors: 27
Average comments per issue: 3.74
Average comments per pull request: 3.03
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0

Past year issues: 10
Past year pull requests: 2
Past year average time to close issues: 2 days
Past year average time to close pull requests: about 2 months
Past year issue authors: 10
Past year pull request authors: 2
Past year average comments per issue: 1.7
Past year average comments per pull request: 2.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/gettalong/kramdown

Top Issue Authors

cabo (4)
EtienneMiret (3)
ashmaroli (3)
boutil (3)
yagarea (3)
jaredcwhite (2)
docsimpo (2)
gsar (2)
SomeWeekendReading (2)
StoneCypher (2)
Freed-Wu (1)
honzasterba (1)
rubyFeedback (1)
nybblr (1)
ahamelers (1)

Top Pull Request Authors

cabo (3)
Krinkle (3)
honzasterba (2)
Convincible (2)
stanhu (2)
BryceStevenWilley (2)
roelbondoc (2)
pwim (2)
ashmaroli (2)
otegami (2)
zenspider (1)
ionactual (1)
sandstrom (1)
jeremiahlukus (1)
ccorn (1)

Top Issue Labels

question (30)
enhancement (12)
bug (10)
needs pull request (4)

Top Pull Request Labels

enhancement (7)
bug (3)

Package metadata

Total packages: 3
Total downloads:
- rubygems: 450,491,847 total
Total docker downloads: 1,833,045,934
Total dependent packages: 659 (may contain duplicates)
Total dependent repositories: 485,486 (may contain duplicates)
Total versions: 136
Total maintainers: 1
Total advisories: 2

gem.coop: kramdown

kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and supporting several common extensions.

Homepage: http://kramdown.gettalong.org
Documentation: http://www.rubydoc.info/gems/kramdown/
Licenses: MIT
Latest release: 2.5.2 (published about 1 month ago)
Last Synced: 2026-03-01T14:32:02.980Z (2 days ago)
Versions: 66
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 225,233,086 Total
Docker Downloads: 916,522,967
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.054%
- Docker downloads count: 0.102%
- Downloads: 0.112%
Maintainers (1)
- gettalong

rubygems.org: kramdown