You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
RedCloth is a Ruby library for converting Textile into HTML.
16
16
17
-
== RedCloth needs new maintainers
18
-
19
-
The {owner of this gem since 2007}[https://github.com/jgarber] is unable to
20
-
keep fixing bugs or work on the next major release, {RedCloth
21
-
5}[https://github.com/jgarber/redcloth-parslet]. He's looking for one or more
22
-
developers who can:
23
-
24
-
<b>Current version</b>
25
-
26
-
* Fix any urgent {bugs}[http://jgarber.lighthouseapp.com/projects/13054-redcloth/overview] in RedCloth 4.x. You'll probably need to know Ragel and understand Ruby extensions in C and perhaps Java.
27
-
* Precompile the gem for Windows and JRuby or fix broken cross-compilation to automate the process
28
-
* Cut releases on the 4.x series.
17
+
== Attention - Deprecating JRuby and Windows support in version 4.3
29
18
30
-
<b>Future version</b>
31
-
32
-
* Complete {redcloth-parslet}[https://github.com/jgarber/redcloth-parslet], which will be a major release and replace this repository when finished. You need to understand the Parslet DSL, which can be learned in a couple hours.
33
-
* Meet or exceed the current level of unit and integration testing. Unit testing of the individual patterns makes it much easier to develop and maintain than the old parser.
34
-
* Release RedCloth 5.0 to much fanfare.
19
+
In 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.
35
20
36
21
== Installing
37
22
38
23
RedCloth can be installed via RubyGems:
39
24
40
25
gem install RedCloth
41
26
42
-
It will install the appropriate Ruby, JRuby, or Win32 gem. If using JRuby,
43
-
version 1.1.5 or greater is required.
44
-
45
27
== Compiling
46
28
47
29
If you just want to use RedCloth, you do NOT need to build/compile it. It is
48
30
compiled from C sources automatically when you install the gem on the ruby
49
-
platform. Precompiled binary gems are provided for JRuby and Win32 platforms.
31
+
platform. Precompiled binary gems are provided for JRuby and Win32 platforms prior to version 4.3.
50
32
51
33
RedCloth can be compiled with <tt>rake compile</tt>. Ragel 6.3 or greater is
52
34
required. Again, Ragel is NOT needed to simply use RedCloth.
53
35
54
36
=== Supported platforms
55
37
56
-
By default, the rake compile task builds a native C extension (MRI 1.8 or 1.9)
57
-
or Java extension (JRuby 1.3). A pure Ruby version can also be generated, but
58
-
it's super slow and Ruby 1.8-only. The JRuby and pure-Ruby extensions don't
59
-
support multi-byte characters. Cross-compiling for win32 uses rake-compiler.
38
+
By 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
39
+
support multi-byte characters.
60
40
61
41
The RedCloth::EXTENSION_LANGUAGE constant indicates in which language your
62
42
copy of RedCloth is compiled.
63
43
64
-
=== Compiling gems
65
-
66
-
To compile MRI, JRuby, and win32 gems, you need rvm and rake-compiler. These
67
-
and other dependencies can be installed with bundler. Then rake build:all
68
-
takes care of compiling and packaging all gems.
69
-
70
-
1. gem install bundler
71
-
2. bundle install
72
-
3. rake-compiler cross-ruby VERSION=1.8.6-p398
73
-
4. rake-compiler cross-ruby VERSION=1.9.1-p243
74
-
5. rake build:all
75
-
76
44
== Bugs
77
45
78
-
Please submit bugs to http://jgarber.lighthouseapp.com/projects/13054-redcloth/overview
0 commit comments