rdoc-rouge 0.0.1 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -1
  3. data/spec/rdoc_rouge_spec.rb +17 -2
  4. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7080455d836e17c338db8a9b85817c342b24dc81
4
- data.tar.gz: 1e186ff813f949579bfe390853173737b235be86
3
+ metadata.gz: ba070ab7ede6033359c4d5e4613730d87dffb2dd
4
+ data.tar.gz: 4abb909c2eb6feafa774b3102b4aed599f910b14
5
5
  SHA512:
6
- metadata.gz: 057f2e8a11a5cd741f1cde56afcf448fd271872584d5d5b413ba0316c98e037118f7f46d9d7323658f595ad7f2f60147c7117e54726ed9b11e0dd82cc2fa46c3
7
- data.tar.gz: 85d81f04f109addb44d43d48eede1519025fd461218b26a8616bdc99488eaba9907788952eb24a3c34cd9ece8b5b0d6602a298fd193955ca971ef6f2c0d75428
6
+ metadata.gz: ef2e0dd043f932eab75c5134f3c76bdb555202c50b074740a066f02e89a0cadc893cf876eecfbbe3054ce543ebf69a7083b7e765974fb2d7ae3d6e07a1069316
7
+ data.tar.gz: c5cf8d33e9c69e0a263352998184decd4be473125d5f69a0e79e0336e8ddf23125fa44090a4096e47eb759cd6f85764aa743fb05a00633da5f7796753e8c88dc
data/README.md CHANGED
@@ -19,7 +19,8 @@ Or install it yourself as:
19
19
  ## Usage
20
20
 
21
21
  require 'rdoc/rouge'
22
- html = RDoc::Rouge::Renderer.render <<-markdown
22
+ renderer = RDoc::Rouge::Renderer
23
+ html = renderer.parse <<-markdown
23
24
  ```ruby
24
25
  def hello(who)
25
26
  puts "Hello, #{who}!"
@@ -27,6 +28,12 @@ Or install it yourself as:
27
28
  ```
28
29
  markdown
29
30
 
31
+ If you just want to generate a table of contents from your markdown, we have
32
+ exposed RDoc::Markup::ToTableOfContents
33
+
34
+ RDoc::Rouge::Renderer.new(:toc => true).parse("# markdown")
35
+ #=> "<li><a href='#label-markdown'>markdown</a></li>"
36
+
30
37
  ## Contributing
31
38
 
32
39
  1. Fork it
@@ -8,8 +8,9 @@ describe RDoc::Rouge do
8
8
  refute version.nil?
9
9
  end
10
10
 
11
- it 'renders a thing' do
12
- result = RDoc::Rouge::Renderer.render <<-mkd
11
+ it "renders a thing" do
12
+ renderer = RDoc::Rouge::Renderer.new
13
+ result = renderer.parse <<-mkd
13
14
  ``` javascript
14
15
  var foo = 1;
15
16
  ```
@@ -24,4 +25,18 @@ foo=1
24
25
  assert doc.search("pre.highlight").size == 2
25
26
  end
26
27
 
28
+ it "renders with pipe" do
29
+ renderer = RDoc::Rouge::Renderer.new(:pipe => true)
30
+ result = renderer.parse "# Hello, World!"
31
+
32
+ assert_equal result, "\n<h1 id=\"label-Hello%2C+World%21\">Hello, World!</h1>\n"
33
+ end
34
+
35
+ it "renders toc" do
36
+ renderer = RDoc::Rouge::Renderer.new(:toc => true)
37
+ result = renderer.parse "# Foo"
38
+
39
+ assert_equal result, "<li><a href='#label-Foo'>Foo</a></li>"
40
+ end
41
+
27
42
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rdoc-rouge
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zachary Scott
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2013-03-20 00:00:00.000000000 Z
11
+ date: 2013-03-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rdoc
@@ -95,6 +95,7 @@ files:
95
95
  - Rakefile
96
96
  - lib/rdoc/rouge.rb
97
97
  - lib/rdoc/rouge/formatter.rb
98
+ - lib/rdoc/rouge/toc.rb
98
99
  - lib/rdoc/rouge/version.rb
99
100
  - rdoc-rouge.gemspec
100
101
  - spec/rdoc_rouge_spec.rb