{"id":13463231,"url":"https://github.com/gettalong/kramdown","last_synced_at":"2025-05-14T08:05:16.942Z","repository":{"id":458569,"uuid":"82580","full_name":"gettalong/kramdown","owner":"gettalong","description":"kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.","archived":false,"fork":false,"pushed_at":"2024-11-18T16:41:59.000Z","size":3487,"stargazers_count":1738,"open_issues_count":12,"forks_count":279,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-05-14T08:04:26.631Z","etag":null,"topics":["html","kramdown","markdown","pdf","ruby"],"latest_commit_sha":null,"homepage":"http://kramdown.gettalong.org","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gettalong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"gettalong","patreon":"gettalong"}},"created_at":"2008-11-30T08:32:47.000Z","updated_at":"2025-05-07T12:18:09.000Z","dependencies_parsed_at":"2022-07-07T23:38:51.429Z","dependency_job_id":"ecf0229c-72c2-4a58-aade-00ee06fc7780","html_url":"https://github.com/gettalong/kramdown","commit_stats":{"total_commits":1130,"total_committers":89,"mean_commits":"12.696629213483146","dds":"0.13362831858407076","last_synced_commit":"fc051a9d93e4dc3ff05bf41b70a79297ebdb669f"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettalong%2Fkramdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettalong%2Fkramdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettalong%2Fkramdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gettalong%2Fkramdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gettalong","download_url":"https://codeload.github.com/gettalong/kramdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254101588,"owners_count":22014907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html","kramdown","markdown","pdf","ruby"],"created_at":"2024-07-31T13:00:48.606Z","updated_at":"2025-05-14T08:05:16.915Z","avatar_url":"https://github.com/gettalong.png","language":"Ruby","funding_links":["https://github.com/sponsors/gettalong","https://patreon.com/gettalong","https://github.com/sponsors/gettalong/","https://www.patreon.com/gettalong"],"categories":["HTML \u0026 Markup","Markdown Processors","Uncategorized","Ruby","Happy Exploring 🤘","Libraries","Gems","Headquarters (HQ)","Markdown Building Blocks","Markdown Libraries"],"sub_categories":["Markup processors","Uncategorized","Ruby","Markdown","Markdown Libraries \u0026 Tools","Ruby Markdown Libraries"],"readme":"# kramdown\n\n## Readme first!\n\nkramdown was originally licensed under the GPL until the 1.0.0 release. However, due to the many\nrequests it is now released under the MIT license and therefore can easily be used in commercial\nprojects, too.\n\nHowever, if you use kramdown in a commercial setting, please consider **contributing back any\nchanges** for the benefit of the community and/or [**becoming a\nsponsor**](https://github.com/sponsors/gettalong/) or [**a\npatron**](https://www.patreon.com/gettalong) - thanks!\n\nSponsors:\n\n* **GROSSWEBER** provides \u003ca href=\"http://grossweber.com/b/kramdown\" target=\"_blank\"\u003esoftware\n  development consulting and training services\u003c/a\u003e.\n\n\n## Introduction\n\nkramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and\nsupporting several common extensions.\n\nThe syntax definition for the kramdown syntax can be found in **doc/syntax.page** (or online at\n\u003chttp://kramdown.gettalong.org/syntax.html\u003e) and a quick reference is available in\n**doc/quickref.page** or online at \u003chttp://kramdown.gettalong.org/quickref.html\u003e.\n\nThe kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However,\ndue to its flexibility (by creating an internal AST) it supports other input and output formats as\nwell. Here is a list of the supported formats:\n\n* input formats: kramdown (a Markdown superset), Markdown, GFM, HTML\n* output formats: HTML, kramdown, LaTeX (and therefore PDF), PDF via Prawn\n\nAll the documentation on the available input and output formats is available in the **doc/**\ndirectory and online at \u003chttp://kramdown.gettalong.org\u003e.\n\nStarting from version 1.0.0 kramdown is using a versioning scheme with major, minor and patch parts\nin the version number where the major number changes on backwards-incompatible changes, the minor\nnumber on the introduction of new features and the patch number on everything else.\n\nFor information about changes between versions, have a look at\n\u003chttp://kramdown.gettalong.org/news.html\u003e or the commit history!\n\n\n## Usage\n\nkramdown has a very simple API, so using kramdown is as easy as\n\n```ruby\nrequire 'kramdown'\n\nKramdown::Document.new(text).to_html\n```\n\nFor detailed information have a look at the API documentation of the `Kramdown::Document` class.\n\nThe full API documentation is available at \u003chttp://kramdown.gettalong.org/rdoc/\u003e, other sites with an\nAPI documentation for kramdown probably don't provide the complete documentation!\n\nThere are also some third-party libraries that extend the functionality of kramdown -- see the\nkramdown Wiki at \u003chttps://github.com/gettalong/kramdown/wiki\u003e.\n\n\n## Development\n\nJust clone the git repository as described in **doc/installation.page** and you are good to go. You\nprobably want to install `rake` so that you can use the provided rake tasks.\n\nIf you want to run the tests, the development dependencies are needed as well as some additional\nprograms like `tidy` and `latex`. See the `.travis.yml` file for more information.\n\n\n## License\n\nMIT - see the **COPYING** file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgettalong%2Fkramdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgettalong%2Fkramdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgettalong%2Fkramdown/lists"}