{"id":13463232,"url":"https://github.com/jgarber/redcloth","last_synced_at":"2025-05-14T16:15:31.362Z","repository":{"id":393772,"uuid":"11635","full_name":"jgarber/redcloth","owner":"jgarber","description":"RedCloth is a Ruby library for converting Textile into HTML.","archived":false,"fork":false,"pushed_at":"2024-04-19T06:19:07.000Z","size":1478,"stargazers_count":446,"open_issues_count":30,"forks_count":104,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-01T21:17:14.891Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ragel","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/jgarber.png","metadata":{"files":{"readme":"README.rdoc","changelog":"CHANGELOG","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":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2008-04-21T20:50:37.000Z","updated_at":"2025-01-09T02:11:13.000Z","dependencies_parsed_at":"2023-07-05T14:46:42.421Z","dependency_job_id":"e9153f5f-1fa7-4710-b920-3cd5771e100e","html_url":"https://github.com/jgarber/redcloth","commit_stats":{"total_commits":626,"total_committers":35,"mean_commits":"17.885714285714286","dds":0.402555910543131,"last_synced_commit":"dd7ee6caaa6c899f4d5389c1b2fe4a17f1e5f326"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jgarber%2Fredcloth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jgarber%2Fredcloth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jgarber%2Fredcloth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jgarber%2Fredcloth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jgarber","download_url":"https://codeload.github.com/jgarber/redcloth/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247935088,"owners_count":21020771,"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":[],"created_at":"2024-07-31T13:00:48.645Z","updated_at":"2025-04-08T22:19:54.005Z","avatar_url":"https://github.com/jgarber.png","language":"Ragel","funding_links":[],"categories":["HTML \u0026 Markup"],"sub_categories":["Markup processors"],"readme":"= RedCloth - Textile parser for Ruby\n\nHomepage::  https://github.com/jgarber/redcloth\nMaintainer:: Helio Cola https://github.com/heliocola\nAuthor::    Jason Garber\nCopyright:: (c) 2011 Jason Garber\nLicense::   MIT\n\n{rdoc-image:https://codeclimate.com/github/jgarber/redcloth/badges/gpa.svg}[https://codeclimate.com/github/jgarber/redcloth]\n\n= RedCloth\n\nRedCloth is a Ruby library for converting Textile into HTML.\n\n== Attention - Deprecating JRuby and Windows support in version 4.3\n\nIn order to prioritize merging a fix for the long standing vulnerability *CVE-2012-6684*, our {new maintainer}[https://github.com/joshuasiler] has elected to stop maintaining the precompiled versions for Windows and JRuby. \n\n== Installing\n\nRedCloth can be installed via RubyGems:\n\n  gem install RedCloth\n\n== Compiling\n\nIf you just want to use RedCloth, you do NOT need to build/compile it. It is\ncompiled from C sources automatically when you install the gem on the ruby\nplatform. Precompiled binary gems are provided for JRuby and Win32 platforms prior to version 4.3.\n\nRedCloth can be compiled with \u003ctt\u003erake compile\u003c/tt\u003e. Ragel 6.3 or greater is\nrequired. Again, Ragel is NOT needed to simply use RedCloth.\n\n=== Supported platforms\n\nBy default, the rake compile task builds a native C extension (MRI 1.8 or 1.9). A pure Ruby version can also be generated, but it's super slow and Ruby 1.8-only, and doesn't\nsupport multi-byte characters. \n\nThe RedCloth::EXTENSION_LANGUAGE constant indicates in which language your\ncopy of RedCloth is compiled.\n\n== Bugs\n\nPlease submit bugs as issues to this repo.\n\n== Using RedCloth\n\nRedCloth is simply an extension of the String class that can handle\nTextile formatting.  Use it like a String and output HTML with its\nRedCloth#to_html method.\n\nSimple use:\n text = \"This is *my* text.\"\n RedCloth.new(text).to_html\n\nMulti-line example:\n\n doc = RedCloth.new \u003c\u003cEOD\n h2. Test document\n\n Just a simple test.\n EOD\n puts doc.to_html\n\n\n== What is Textile?\n\nTextile is a simple formatting style for text\ndocuments, loosely based on some HTML conventions.\n\n== Sample Textile Text\n\n h2. This is a title\n\n h3. This is a subhead\n\n This is a bit of paragraph.\n\n bq. This is a blockquote.\n\n= Writing Textile\n\nA Textile document consists of paragraphs.  Paragraphs\ncan be specially formatted by adding a small instruction\nto the beginning of the paragraph.\n\n h3.     Header 3.\n bq.     Blockquote.\n #       Numeric list.\n *       Bulleted list.\n\n== Quick Phrase Modifiers\n\nQuick phrase modifiers are also included, to allow formatting\nof small portions of text within a paragraph.\n\n _emphasis_\n __italicized__\n *strong*\n **bold**\n ??citation??\n -deleted text-\n +inserted text+\n ^superscript^\n ~subscript~\n @code@\n %(classname)span%\n\n ==notextile== (leave text alone)\n\n== Links\n\nTo make a hypertext link, put the link text in \"quotation\nmarks\" followed immediately by a colon and the URL of the link.\n\nOptional: text in (parentheses) following the link text,\nbut before the closing quotation mark, will become a title\nattribute for the link, visible as a tool tip when a cursor is above it.\n\nExample:\n\n \"This is a link (This is a title)\":http://www.textism.com\n\nWill become:\n\n \u003ca href=\"http://www.textism.com\" title=\"This is a title\"\u003eThis is a link\u003c/a\u003e\n\n== Images\n\nTo insert an image, put the URL for the image inside exclamation marks.\n\nOptional: text that immediately follows the URL in (parentheses) will\nbe used as the Alt text for the image. Images on the web should always\nhave descriptive Alt text for the benefit of readers using non-graphical\nbrowsers.\n\nOptional: place a colon followed by a URL immediately after the\nclosing ! to make the image into a link.\n\nExample:\n\n !http://www.textism.com/common/textist.gif(Textist)!\n\nWill become:\n\n \u003cimg src=\"http://www.textism.com/common/textist.gif\" alt=\"Textist\" /\u003e\n\nWith a link:\n\n !/common/textist.gif(Textist)!:http://textism.com\n\nWill become:\n\n \u003ca href=\"http://textism.com\"\u003e\u003cimg src=\"/common/textist.gif\" alt=\"Textist\" /\u003e\u003c/a\u003e\n\n== Defining Acronyms\n\nHTML allows authors to define acronyms via the tag. The definition appears as a\ntool tip when a cursor hovers over the acronym. A crucial aid to clear writing,\nthis should be used at least once for each acronym in documents where they appear.\n\nTo quickly define an acronym in Textile, place the full text in (parentheses)\nimmediately following the acronym.\n\nExample:\n\n ACLU(American Civil Liberties Union)\n\nWill become:\n\n \u003cacronym title=\"American Civil Liberties Union\"\u003eACLU\u003c/acronym\u003e\n \n== Filtering HTML\n\nRedCloth doesn't filter unsafe html tags by default, do to this use the following syntax:\n  RedCloth.new(\"\u003cscript\u003ealert(1)\u003c/script\u003e\", [:filter_html]).to_html\nwhich will filter the script tags from the HTML resulting in:\n  \"\u0026lt;script\u0026gt;alert(1)\u0026lt;/script\u0026gt;\"\n\n== Adding Tables\n\nIn Textile, simple tables can be added by separating each column by\na pipe.\n\n    |a|simple|table|row|\n    |And|Another|table|row|\n\nStyles are applied with curly braces.\n\n    table{border:1px solid black}.\n    {background:#ddd;color:red}. |a|red|row|\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjgarber%2Fredcloth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjgarber%2Fredcloth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjgarber%2Fredcloth/lists"}