rdoc2md 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/History.txt +4 -0
- data/README.txt +3 -0
- data/lib/rdoc2md.rb +2 -2
- data/test/test_rdoc2md.rb +9 -0
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 76f4f5dd8a9a3caec151997287cccb0fd60f642c
|
4
|
+
data.tar.gz: 41dec21dcaa5ef5eeea474de98f2df3ff460d4c8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e81ce9796784b63194700b51b5233752057f17b058b481229c9715bdbd5cdfacb2fea2d8f1aa43ec320a71e0a5103861b14b77ca2ba39752713f4d452891c103
|
7
|
+
data.tar.gz: af6e967cd81e21a406e34ea13dfa845c19ff20d3b141bc4cb334ffbf01e1600dc95dd5c0d41acdb0e8f4d1309d1b44ccba36935749fea674146556e1e8edc5d4
|
data/History.txt
CHANGED
data/README.txt
CHANGED
@@ -10,6 +10,9 @@ file in Rdoc format. Github expects a README.md file to display nicely on the w
|
|
10
10
|
This utility lets you make the .txt file the master and autogenerate the .md version
|
11
11
|
without Repeating Yourself.
|
12
12
|
|
13
|
+
Incidentally, if you are reading this on github, this README was produced by +rdoc2md+.
|
14
|
+
Kinda meta, eh?
|
15
|
+
|
13
16
|
== Usage
|
14
17
|
|
15
18
|
To use +rdoc2md+, first install it:
|
data/lib/rdoc2md.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
|
2
2
|
module Rdoc2md
|
3
|
-
VERSION = "0.1.
|
3
|
+
VERSION = "0.1.1"
|
4
4
|
|
5
5
|
# Rdoc2md::Document takes a String representing a document in Rdoc format (sans leading
|
6
6
|
# hashmark comments) and converts it into a similar markdown document.
|
@@ -41,7 +41,7 @@ module Rdoc2md
|
|
41
41
|
result.gsub!(/(\A|[^\\\*])\*([^\*]*[^\*\\])\*/, '\1**\2**')
|
42
42
|
|
43
43
|
# Convert inline code spans to use backticks
|
44
|
-
result.gsub!(/(\A|[^\\])\+([^\+]
|
44
|
+
result.gsub!(/(\A|[^\\])\+([^\+]+)\+/, '\1`\2`')
|
45
45
|
|
46
46
|
# Convert bare http:, mailto: and ftp: links
|
47
47
|
result.gsub!(/(\A|\s)(http:|https:|mailto:|ftp:)(\S*)/, '\1[\2\3](\2\3)')
|
data/test/test_rdoc2md.rb
CHANGED
@@ -187,6 +187,15 @@ EOF
|
|
187
187
|
end
|
188
188
|
|
189
189
|
|
190
|
+
should "leave backslashed typewriter untouched when describing C++" do
|
191
|
+
text = <<EOF
|
192
|
+
This is C++
|
193
|
+
EOF
|
194
|
+
result = Rdoc2md::Document.new(text).to_md
|
195
|
+
assert_equal text, result
|
196
|
+
end
|
197
|
+
|
198
|
+
|
190
199
|
should "convert bare http reference to square bracketed with url as label" do
|
191
200
|
text = <<EOF
|
192
201
|
Ruby : http://www.ruby-lang.org
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rdoc2md
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Kirk Bowers
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-03-
|
11
|
+
date: 2014-03-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rdoc
|
@@ -44,6 +44,9 @@ description: |-
|
|
44
44
|
file in Rdoc format. Github expects a README.md file to display nicely on the webpage.
|
45
45
|
This utility lets you make the .txt file the master and autogenerate the .md version
|
46
46
|
without Repeating Yourself.
|
47
|
+
|
48
|
+
Incidentally, if you are reading this on github, this README was produced by +rdoc2md+.
|
49
|
+
Kinda meta, eh?
|
47
50
|
email:
|
48
51
|
- kirkbowers@yahoo.com
|
49
52
|
executables:
|