github-markup 1.4.6 → 1.4.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +1 -0
- data/Gemfile +1 -3
- data/README.md +9 -7
- data/github-markup.gemspec +6 -3
- data/lib/github-markup.rb +1 -1
- metadata +68 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c40568c5b410191a272ca0ff270dce0581fc0e68
|
4
|
+
data.tar.gz: f9e06dd0788b118eedde27f4f042e6ee3523eab8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13d99a476dd4dd050bc5d4097dca3f0272c53bdeeb6a4244d6db039b657c95d35003f8e2dbb2fe650de672ae8b5d2fef1a0610b25375177363ebb9126a6af430
|
7
|
+
data.tar.gz: 3c5fd1f600a2c69d2617ff677a3c5afc9382f5b8dbd75f72519c56f37a3b51a87b559c72e6b7ae1be51ce8515c10d4b2a77ea23a07ff860844d31657abff87f5
|
data/CONTRIBUTING.md
CHANGED
@@ -1,6 +1,7 @@
|
|
1
1
|
# Contributing
|
2
2
|
|
3
3
|
This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
|
4
|
+
|
4
5
|
[code-of-conduct]: http://todogroup.org/opencodeofconduct/#GitHub%20Markup/opensource@github.com
|
5
6
|
|
6
7
|
This library's only job is to decide which markup format to use and call out to an external library to convert the markup to HTML (see the [README](README.md) for more information on how markup is rendered on GitHub.com).
|
data/Gemfile
CHANGED
@@ -4,12 +4,10 @@ gemspec
|
|
4
4
|
gem "posix-spawn", :platforms => :ruby
|
5
5
|
gem "redcarpet", :platforms => :ruby
|
6
6
|
gem "kramdown", :platforms => :jruby
|
7
|
-
gem "
|
7
|
+
gem "commonmarker", "~> 0.14.9"
|
8
8
|
gem "rdoc", "~>3.6"
|
9
9
|
gem "org-ruby", "= 0.9.9"
|
10
10
|
gem "creole", "~>0.3.6"
|
11
11
|
gem "wikicloth", "=0.8.3"
|
12
12
|
gem "asciidoctor", "= 1.5.2"
|
13
13
|
gem "rake"
|
14
|
-
gem "rinku", '~> 1'
|
15
|
-
gem "github-linguist", ">= 5.0.7"
|
data/README.md
CHANGED
@@ -3,11 +3,13 @@ GitHub Markup
|
|
3
3
|
|
4
4
|
This library is the first step of a journey that every markup file in a repository goes on before it is rendered on GitHub.com:
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
6
|
+
1. This library converts the raw markup to HTML. See the list of [supported markup formats](#markups) below.
|
7
|
+
1. The HTML is sanitized, aggressively removing things that could harm you and your kin—such as `script` tags, inline-styles, and `class` or `id` attributes. See the [sanitization filter](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/sanitization_filter.rb) for the full whitelist.
|
8
|
+
1. Syntax highlighting is performed on code blocks. See [github/linguist](https://github.com/github/linguist#syntax-highlighting) for more information about syntax highlighting.
|
9
|
+
1. The HTML is passed through other filters in the [html-pipeline](https://github.com/jch/html-pipeline) that add special sauce, such as [emoji](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/emoji_filter.rb), [task lists](https://github.com/github/task_list/blob/master/lib/task_list/filter.rb), [named anchors](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb), [CDN caching for images](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/camo_filter.rb), and [autolinking](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/autolink_filter.rb).
|
10
|
+
1. The resulting HTML is rendered on GitHub.com.
|
11
|
+
|
12
|
+
Please note that **only the first step** is covered by this gem — the rest happens on GitHub.com. In particular, `markup` itself does no sanitization of the resulting HTML, as it expects that to be covered by whatever pipeline is consuming the HTML.
|
11
13
|
|
12
14
|
Please see our [contributing guidelines](CONTRIBUTING.md) before reporting an issue.
|
13
15
|
|
@@ -17,7 +19,7 @@ Markups
|
|
17
19
|
The following markups are supported. The dependencies listed are required if
|
18
20
|
you wish to run the library. You can also run `script/bootstrap` to fetch them all.
|
19
21
|
|
20
|
-
* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install
|
22
|
+
* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install commonmarker` (https://github.com/gjtorikian/commonmarker)
|
21
23
|
* [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
|
22
24
|
* [.rdoc](https://rdoc.github.io/rdoc/) -- `gem install rdoc -v 3.6.1`
|
23
25
|
* [.org](http://orgmode.org/) -- `gem install org-ruby`
|
@@ -67,4 +69,4 @@ GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, '* One\n* Two')
|
|
67
69
|
Contributing
|
68
70
|
------------
|
69
71
|
|
70
|
-
See [Contributing](CONTRIBUTING.md)
|
72
|
+
See [Contributing](CONTRIBUTING.md).
|
data/github-markup.gemspec
CHANGED
@@ -16,10 +16,13 @@ Gem::Specification.new do |s|
|
|
16
16
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
17
17
|
s.require_paths = %w[lib]
|
18
18
|
|
19
|
+
s.add_dependency "github-linguist", "~> 5.0", ">= 5.0.7"
|
20
|
+
s.add_dependency "rinku", '~> 1'
|
21
|
+
s.add_development_dependency 'rake', '~> 12'
|
19
22
|
s.add_development_dependency 'activesupport', '~> 4.0'
|
20
|
-
s.add_development_dependency 'minitest', '~> 5.4.3'
|
23
|
+
s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3'
|
21
24
|
s.add_development_dependency 'html-pipeline', '~> 1.0'
|
22
|
-
s.add_development_dependency 'sanitize', '~> 2.1.0'
|
23
|
-
s.add_development_dependency 'nokogiri', '~> 1.6.1'
|
25
|
+
s.add_development_dependency 'sanitize', '~> 2.1', '>= 2.1.0'
|
26
|
+
s.add_development_dependency 'nokogiri', '~> 1.6', '>= 1.6.1'
|
24
27
|
s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
|
25
28
|
end
|
data/lib/github-markup.rb
CHANGED
metadata
CHANGED
@@ -1,15 +1,63 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: github-markup
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.4.
|
4
|
+
version: 1.4.7
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Chris Wanstrath
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-03-
|
11
|
+
date: 2017-03-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: github-linguist
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '5.0'
|
20
|
+
- - ">="
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 5.0.7
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - "~>"
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '5.0'
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 5.0.7
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: rinku
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1'
|
40
|
+
type: :runtime
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: rake
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '12'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '12'
|
13
61
|
- !ruby/object:Gem::Dependency
|
14
62
|
name: activesupport
|
15
63
|
requirement: !ruby/object:Gem::Requirement
|
@@ -29,6 +77,9 @@ dependencies:
|
|
29
77
|
requirement: !ruby/object:Gem::Requirement
|
30
78
|
requirements:
|
31
79
|
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '5.4'
|
82
|
+
- - ">="
|
32
83
|
- !ruby/object:Gem::Version
|
33
84
|
version: 5.4.3
|
34
85
|
type: :development
|
@@ -36,6 +87,9 @@ dependencies:
|
|
36
87
|
version_requirements: !ruby/object:Gem::Requirement
|
37
88
|
requirements:
|
38
89
|
- - "~>"
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '5.4'
|
92
|
+
- - ">="
|
39
93
|
- !ruby/object:Gem::Version
|
40
94
|
version: 5.4.3
|
41
95
|
- !ruby/object:Gem::Dependency
|
@@ -57,6 +111,9 @@ dependencies:
|
|
57
111
|
requirement: !ruby/object:Gem::Requirement
|
58
112
|
requirements:
|
59
113
|
- - "~>"
|
114
|
+
- !ruby/object:Gem::Version
|
115
|
+
version: '2.1'
|
116
|
+
- - ">="
|
60
117
|
- !ruby/object:Gem::Version
|
61
118
|
version: 2.1.0
|
62
119
|
type: :development
|
@@ -64,6 +121,9 @@ dependencies:
|
|
64
121
|
version_requirements: !ruby/object:Gem::Requirement
|
65
122
|
requirements:
|
66
123
|
- - "~>"
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '2.1'
|
126
|
+
- - ">="
|
67
127
|
- !ruby/object:Gem::Version
|
68
128
|
version: 2.1.0
|
69
129
|
- !ruby/object:Gem::Dependency
|
@@ -71,6 +131,9 @@ dependencies:
|
|
71
131
|
requirement: !ruby/object:Gem::Requirement
|
72
132
|
requirements:
|
73
133
|
- - "~>"
|
134
|
+
- !ruby/object:Gem::Version
|
135
|
+
version: '1.6'
|
136
|
+
- - ">="
|
74
137
|
- !ruby/object:Gem::Version
|
75
138
|
version: 1.6.1
|
76
139
|
type: :development
|
@@ -78,6 +141,9 @@ dependencies:
|
|
78
141
|
version_requirements: !ruby/object:Gem::Requirement
|
79
142
|
requirements:
|
80
143
|
- - "~>"
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '1.6'
|
146
|
+
- - ">="
|
81
147
|
- !ruby/object:Gem::Version
|
82
148
|
version: 1.6.1
|
83
149
|
- !ruby/object:Gem::Dependency
|