File: README.markdown

package info (click to toggle)
ruby-rdiscount 2.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid, stretch
  • size: 412 kB
  • ctags: 578
  • sloc: ansic: 4,122; ruby: 447; makefile: 2
file content (72 lines) | stat: -rw-r--r-- 2,249 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
Discount Markdown Processor for Ruby
====================================
[![Build Status](https://travis-ci.org/davidfstr/rdiscount.png)](https://travis-ci.org/davidfstr/rdiscount)

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: <http://dafoster.net/projects/rdiscount/>  
DOCS: <http://rdoc.info/github/davidfstr/rdiscount/master/RDiscount>  
BUGS: <http://github.com/davidfstr/rdiscount/issues>  

Discount was developed by [David Loren Parsons][3]. The Ruby extension
is maintained by [David Foster][4].

[1]: http://daringfireball.net/projects/markdown/syntax
[2]: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip
[3]: http://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.