https://github.com/rtomayko/rdiscount

Discount (For Ruby) Implementation of John Gruber's Markdown
https://github.com/rtomayko/rdiscount

markdown markdown-parser

Last synced: about 1 month ago
JSON representation

Discount (For Ruby) Implementation of John Gruber's Markdown

• Host: GitHub
• URL: https://github.com/rtomayko/rdiscount
• Owner: davidfstr
• License: other
• Created: 2008-05-30T16:54:07.000Z (over 16 years ago)
• Default Branch: master
• Last Pushed: 2023-12-31T17:40:35.000Z (9 months ago)
• Last Synced: 2024-08-05T16:12:33.583Z (about 2 months ago)
• Topics: markdown, markdown-parser
• Language: C
• Homepage: http://dafoster.net/projects/rdiscount/
• Size: 488 KB
• Stars: 755
• Watchers: 20
• Forks: 70
• Open Issues: 3
• Metadata Files:
  • Readme: README.markdown
  • Changelog: CHANGELOG.md
  • License: COPYING

Awesome Lists containing this project

• awesome-ruby-toolbox - Rdiscount - Fast Implementation of Gruber's Markdown in C (HTML & Markup / Markup processors)

README

        
Discount Markdown Processor for Ruby

====================================

[![Build Status](https://github.com/davidfstr/rdiscount/actions/workflows/main.yml/badge.svg)](https://github.com/davidfstr/rdiscount/actions/workflows/main.yml)

Discount is an implementation of John Gruber's Markdown markup language in C.

It implements all of the language described in [the markdown syntax document][1] and

passes the [Markdown 1.0 test suite][2].

CODE: `git clone git://github.com/davidfstr/rdiscount.git`  

HOME:   

DOCS:   

BUGS: 

Discount was developed by [David Loren Parsons][3].

The Ruby extension is maintained by [David Foster][4].

[1]: https://daringfireball.net/projects/markdown/syntax

[2]: https://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip

[3]: https://www.pell.portland.or.us/~orc

[4]: https://github.com/davidfstr

INSTALL, HACKING

----------------

New releases of RDiscount are published to [RubyGems][]:

    $ [sudo] gem install rdiscount

The RDiscount sources are available via Git:

    $ git clone git://github.com/davidfstr/rdiscount.git

    $ cd rdiscount

    $ rake --tasks

See the file [BUILDING][] for hacking instructions.

[RubyGems]: https://rubygems.org/gems/rdiscount

[BUILDING]: https://github.com/davidfstr/rdiscount/blob/master/BUILDING

USAGE

-----

RDiscount implements the basic protocol popularized by RedCloth and adopted

by BlueCloth:

    require 'rdiscount'

    markdown = RDiscount.new("Hello World!")

    puts markdown.to_html

Additional processing options can be turned on when creating the

RDiscount object:

    markdown = RDiscount.new("Hello World!", :smart, :filter_html)

Inject RDiscount into your BlueCloth-using code by replacing your bluecloth

require statements with the following:

    begin

      require 'rdiscount'

      BlueCloth = RDiscount

    rescue LoadError

      require 'bluecloth'

    end

COPYING

-------

Discount is free software;  it is released under a BSD-style license

that allows you to do as you wish with it as long as you don't attempt

to claim it as your own work. RDiscount adopts Discount's license

verbatim. See the file `COPYING` for more information.