jekyll-theme-gh-readme 1.0.0
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 +7 -0
- data/_layouts/default.html +37 -0
- data/assets/main.css +312 -0
- data/assets/nav.js +87 -0
- metadata +117 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 30b5f2b7bba57024d7c37858fc1a44ea4aed98b5
|
4
|
+
data.tar.gz: 697dfbfcea7d010a0ecafb286c468c32e2f4cc71
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: af809d7d0319539b8d0768c1b8278358de9bde968572aa56ff9d125b197cacc6c13d03f21cc451aa512375b68d625174a2d8c72129b5d48fcff62aa0432de0e3
|
7
|
+
data.tar.gz: 52f9bc24ff4f9835a6ec36bda480dcc9a15105c2c9cb1edff1cad23fb26a5eeb3a901b016895af68538dce1b1597496cc403d946e8124947eb159b056b03484c
|
@@ -0,0 +1,37 @@
|
|
1
|
+
<!doctype html>
|
2
|
+
<html lang="{{ site.lang | default: "en-US" }}">
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
6
|
+
{% seo %}
|
7
|
+
<link rel="stylesheet" href="{{ '/assets/main.css?v=' | append: site.github.build_revision | relative_url }}">
|
8
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700%7CRoboto+Mono:400,300,500">
|
9
|
+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.2.0/styles/github.min.css">
|
10
|
+
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
11
|
+
</head>
|
12
|
+
<body>
|
13
|
+
<a href="{{ site.github.repository_url }}"><img style="position:fixed;z-index:1000;top:0;right:0;border:0;width:149px;height:149px;" src="http://aral.github.com/fork-me-on-github-retina-ribbons/right-red@2x.png" alt="Fork me on GitHub"></a>
|
14
|
+
|
15
|
+
|
16
|
+
<div id="nav"></div>
|
17
|
+
<div class="readme">
|
18
|
+
{{ content }}
|
19
|
+
</div>
|
20
|
+
|
21
|
+
{% if site.google_analytics %}
|
22
|
+
<script>
|
23
|
+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
24
|
+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
25
|
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
26
|
+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
27
|
+
ga('create', '{{ site.google_analytics }}', 'auto');
|
28
|
+
ga('send', 'pageview');
|
29
|
+
</script>
|
30
|
+
{% endif %}
|
31
|
+
|
32
|
+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.5/highlight.min.js"></script>
|
33
|
+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.2/jquery.min.js"></script>
|
34
|
+
<script src="{{ '/assets/nav.js?v=' | append: site.github.build_revision | relative_url }}"></script>
|
35
|
+
<script>hljs.initHighlightingOnLoad();</script>
|
36
|
+
</body>
|
37
|
+
</html>
|
data/assets/main.css
ADDED
@@ -0,0 +1,312 @@
|
|
1
|
+
body {
|
2
|
+
margin: 0;
|
3
|
+
padding: 0;
|
4
|
+
}
|
5
|
+
|
6
|
+
/**
|
7
|
+
* Layout
|
8
|
+
*/
|
9
|
+
|
10
|
+
.readme {
|
11
|
+
margin: 3em;
|
12
|
+
}
|
13
|
+
|
14
|
+
#nav {
|
15
|
+
display: none;
|
16
|
+
}
|
17
|
+
|
18
|
+
@media only screen and (min-device-width: 736px) and (min-width: 1000px) {
|
19
|
+
.readme {
|
20
|
+
width: 650px;
|
21
|
+
}
|
22
|
+
|
23
|
+
#nav {
|
24
|
+
display: block;
|
25
|
+
position: fixed;
|
26
|
+
top: 0;
|
27
|
+
left: 0;
|
28
|
+
margin: 0;
|
29
|
+
width: 17rem;
|
30
|
+
height: 100%;
|
31
|
+
overflow: auto;
|
32
|
+
background-color: #2d2d2d;
|
33
|
+
padding-top: 1rem;
|
34
|
+
}
|
35
|
+
|
36
|
+
#nav ul li {
|
37
|
+
font-size: 0.9rem;
|
38
|
+
list-style-type: none;
|
39
|
+
margin-left: -1rem;
|
40
|
+
margin-top: 0.5em;
|
41
|
+
}
|
42
|
+
|
43
|
+
#nav ul li.active {
|
44
|
+
background-color: #6c2022;
|
45
|
+
}
|
46
|
+
|
47
|
+
#nav ul li.active ul {
|
48
|
+
background-color: #2d2d2d;
|
49
|
+
}
|
50
|
+
|
51
|
+
#nav ul .secnum {
|
52
|
+
color: #777;
|
53
|
+
font-size: 0.85rem;
|
54
|
+
}
|
55
|
+
|
56
|
+
#nav ul a,
|
57
|
+
#nav ul a:visited {
|
58
|
+
color: white;
|
59
|
+
text-shadow: none;
|
60
|
+
text-decoration: none;
|
61
|
+
background: none;
|
62
|
+
}
|
63
|
+
|
64
|
+
.readme {
|
65
|
+
margin-left: 20rem;
|
66
|
+
padding: 2rem;
|
67
|
+
}
|
68
|
+
}
|
69
|
+
|
70
|
+
@media only screen and (min-width: 1000px) {
|
71
|
+
.readme {
|
72
|
+
width: 650px;
|
73
|
+
}
|
74
|
+
}
|
75
|
+
|
76
|
+
@media only screen and (min-width: 1100px) {
|
77
|
+
.readme {
|
78
|
+
width: 750px;
|
79
|
+
}
|
80
|
+
}
|
81
|
+
|
82
|
+
/**
|
83
|
+
* Typography
|
84
|
+
*/
|
85
|
+
#nav,
|
86
|
+
.readme,
|
87
|
+
.readme p {
|
88
|
+
font-family: 'Roboto', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
89
|
+
font-weight: 300;
|
90
|
+
}
|
91
|
+
|
92
|
+
.readme pre,
|
93
|
+
.readme code {
|
94
|
+
font-family: 'Roboto Mono', monospace;
|
95
|
+
}
|
96
|
+
|
97
|
+
.readme ::selection {
|
98
|
+
background: #DEE7FF;
|
99
|
+
}
|
100
|
+
.readme ::-moz-selection {
|
101
|
+
background: #DEE7FF;
|
102
|
+
}
|
103
|
+
|
104
|
+
.readme > :first-child {
|
105
|
+
margin-top: 0;
|
106
|
+
}
|
107
|
+
|
108
|
+
/**
|
109
|
+
* Headers
|
110
|
+
*/
|
111
|
+
.readme h1,
|
112
|
+
.readme h2,
|
113
|
+
.readme h3,
|
114
|
+
.readme h4,
|
115
|
+
.readme h5,
|
116
|
+
.readme h6 {
|
117
|
+
font-family: 'Roboto', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
118
|
+
font-weight: 100;
|
119
|
+
line-height: 1.2em;
|
120
|
+
color: #34363B;
|
121
|
+
position: relative;
|
122
|
+
}
|
123
|
+
|
124
|
+
.readme > h1:first-child,
|
125
|
+
.readme > hr + h1:not(:first-child) {
|
126
|
+
font-size: 2.5rem;
|
127
|
+
border-bottom: 0;
|
128
|
+
padding-bottom: 0;
|
129
|
+
}
|
130
|
+
|
131
|
+
.readme > h1:not(:first-child),
|
132
|
+
.readme > h2 {
|
133
|
+
font-size: 2rem;
|
134
|
+
margin-top: 3rem;
|
135
|
+
border-bottom: 1px dotted #DEE7FF;
|
136
|
+
padding-bottom: 0.4em;
|
137
|
+
}
|
138
|
+
|
139
|
+
.readme h3 {
|
140
|
+
font-weight: 400;
|
141
|
+
margin-top: 2em;
|
142
|
+
color: #4A4F5E;
|
143
|
+
}
|
144
|
+
|
145
|
+
.readme h3 + h3,
|
146
|
+
.readme h4 + h4 {
|
147
|
+
margin-top: -0.5em;
|
148
|
+
}
|
149
|
+
|
150
|
+
.readme h2 + h3 {
|
151
|
+
margin-top: 0;
|
152
|
+
}
|
153
|
+
|
154
|
+
/**
|
155
|
+
* Paragraphs
|
156
|
+
*/
|
157
|
+
|
158
|
+
.readme p,
|
159
|
+
.readme > ul,
|
160
|
+
.readme > ol {
|
161
|
+
line-height: 1.6em;
|
162
|
+
}
|
163
|
+
|
164
|
+
/**
|
165
|
+
* Links
|
166
|
+
*/
|
167
|
+
|
168
|
+
.readme a {
|
169
|
+
color: #4078c0;
|
170
|
+
text-decoration: none;
|
171
|
+
}
|
172
|
+
|
173
|
+
.readme a:hover,
|
174
|
+
.readme a:active {
|
175
|
+
text-decoration: underline;
|
176
|
+
}
|
177
|
+
|
178
|
+
.readme a img {
|
179
|
+
border: 0 none;
|
180
|
+
}
|
181
|
+
|
182
|
+
/**
|
183
|
+
* Horizontal Rules
|
184
|
+
*/
|
185
|
+
|
186
|
+
.readme hr {
|
187
|
+
width: 8px; height: 8px;
|
188
|
+
background: transparent;
|
189
|
+
border: 1px solid #A9B0C2;
|
190
|
+
border-radius: 17px;
|
191
|
+
margin: 4rem auto;
|
192
|
+
position: relative;
|
193
|
+
}
|
194
|
+
|
195
|
+
.readme hr:before,
|
196
|
+
.readme hr:after {
|
197
|
+
position: absolute;
|
198
|
+
top: 1px;
|
199
|
+
left: -24px;
|
200
|
+
width: 4px; height: 4px;
|
201
|
+
background: transparent;
|
202
|
+
content: '';
|
203
|
+
border-radius: 9px;
|
204
|
+
border: 1px solid #A9B0C2;
|
205
|
+
}
|
206
|
+
|
207
|
+
.readme hr:after {
|
208
|
+
left: auto;
|
209
|
+
right: -24px;
|
210
|
+
}
|
211
|
+
|
212
|
+
/**
|
213
|
+
* Lists
|
214
|
+
*/
|
215
|
+
|
216
|
+
.readme li {
|
217
|
+
margin-bottom: 0.2em;
|
218
|
+
position: relative;
|
219
|
+
}
|
220
|
+
.readme li > :first-child {
|
221
|
+
margin-top: 0;
|
222
|
+
}
|
223
|
+
|
224
|
+
.readme ul {
|
225
|
+
list-style-type: none;
|
226
|
+
}
|
227
|
+
|
228
|
+
.readme ul > li:not(.no-bullet):before {
|
229
|
+
content: '*';
|
230
|
+
color: #A9B0C2;
|
231
|
+
position: absolute;
|
232
|
+
left: -1rem;
|
233
|
+
}
|
234
|
+
|
235
|
+
.readme ul > li.no-bullet {
|
236
|
+
margin-left: -1rem;
|
237
|
+
}
|
238
|
+
|
239
|
+
.readme ul,
|
240
|
+
.readme ol {
|
241
|
+
margin: 1rem;
|
242
|
+
padding-left: 0;
|
243
|
+
}
|
244
|
+
|
245
|
+
.readme ul ul,
|
246
|
+
.readme ul ol,
|
247
|
+
.readme ol ol,
|
248
|
+
.readme ol ul {
|
249
|
+
padding-left: 1rem;
|
250
|
+
margin: 0;
|
251
|
+
}
|
252
|
+
|
253
|
+
/*
|
254
|
+
* Code
|
255
|
+
*/
|
256
|
+
|
257
|
+
.readme pre code {
|
258
|
+
max-height: 800px;
|
259
|
+
}
|
260
|
+
|
261
|
+
.readme code {
|
262
|
+
font-size: 0.9rem;
|
263
|
+
}
|
264
|
+
|
265
|
+
.readme p code,
|
266
|
+
.readme table code {
|
267
|
+
color: #c7254e;
|
268
|
+
background: #f9f2f4;
|
269
|
+
padding: 0.2em 0.4em;
|
270
|
+
border-radius: 5px;
|
271
|
+
}
|
272
|
+
|
273
|
+
/*
|
274
|
+
* Table
|
275
|
+
*/
|
276
|
+
|
277
|
+
.readme table {
|
278
|
+
border-spacing: 0;
|
279
|
+
border-collapse: collapse;
|
280
|
+
}
|
281
|
+
|
282
|
+
.readme table > tbody > tr > td,
|
283
|
+
.readme table > tbody > tr > th,
|
284
|
+
.readme table > tfoot > tr > td,
|
285
|
+
.readme table > tfoot > tr > th,
|
286
|
+
.readme table > thead > tr > td,
|
287
|
+
.readme table > thead > tr > th {
|
288
|
+
padding: 8px;
|
289
|
+
line-height: 1.42857143;
|
290
|
+
vertical-align: top;
|
291
|
+
}
|
292
|
+
|
293
|
+
.readme table > thead > tr > th {
|
294
|
+
vertical-align: bottom;
|
295
|
+
border-bottom: 2px solid #ddd
|
296
|
+
}
|
297
|
+
|
298
|
+
.readme table > tbody > tr > td {
|
299
|
+
padding: 8px;
|
300
|
+
line-height: 1.42857143;
|
301
|
+
vertical-align: top;
|
302
|
+
border-top: 1px solid #ddd
|
303
|
+
}
|
304
|
+
|
305
|
+
|
306
|
+
/*
|
307
|
+
* Images
|
308
|
+
*/
|
309
|
+
|
310
|
+
.readme p img {
|
311
|
+
max-width: 100%;
|
312
|
+
}
|
data/assets/nav.js
ADDED
@@ -0,0 +1,87 @@
|
|
1
|
+
$(function () {
|
2
|
+
var nav = $("<ul>");
|
3
|
+
$("#nav").append(nav);
|
4
|
+
var h2;
|
5
|
+
$(".readme > h2, .readme > h3").each(function () {
|
6
|
+
var item = $('<li><a href="#' + $(this).attr("id") + '">' + $(this).text() + '</a>');
|
7
|
+
if ($(this).prop("tagName") == "H3") {
|
8
|
+
if (!h2) {
|
9
|
+
return;
|
10
|
+
}
|
11
|
+
h2.append(item);
|
12
|
+
} else {
|
13
|
+
h2 = $("<ul>");
|
14
|
+
item.append(h2);
|
15
|
+
nav.append(item);
|
16
|
+
}
|
17
|
+
});
|
18
|
+
|
19
|
+
// Add numbering
|
20
|
+
function numberize(prefix) {
|
21
|
+
var ch = 1;
|
22
|
+
return function() {
|
23
|
+
$(this).prepend('<span class="secnum">' + prefix + ch + '</span> ');
|
24
|
+
$("ul > li", this).each(numberize(ch + "."));
|
25
|
+
ch++;
|
26
|
+
}
|
27
|
+
}
|
28
|
+
$("#nav > ul > li").each(numberize(""));
|
29
|
+
|
30
|
+
// Cache selectors
|
31
|
+
var lastId,
|
32
|
+
topMenu = $("#nav > ul"),
|
33
|
+
// All list items
|
34
|
+
menuItems = topMenu.find("a"),
|
35
|
+
// Anchors corresponding to menu items
|
36
|
+
scrollItems = menuItems.map(function() {
|
37
|
+
var item = $($(this).attr("href"));
|
38
|
+
if (item.length) {
|
39
|
+
return item;
|
40
|
+
}
|
41
|
+
});
|
42
|
+
|
43
|
+
// Bind click handler to menu items
|
44
|
+
// so we can get a fancy scroll animation
|
45
|
+
menuItems.click(function(e){
|
46
|
+
var href = $(this).attr("href"),
|
47
|
+
offsetTop = href === "#" ? 0 : $(href).offset().top - topMenuHeight + 1;
|
48
|
+
$('html, body').stop().animate({
|
49
|
+
scrollTop: offsetTop
|
50
|
+
}, 300);
|
51
|
+
e.preventDefault();
|
52
|
+
});
|
53
|
+
|
54
|
+
// Recompute items position on resize
|
55
|
+
$(window).resize(function() {
|
56
|
+
scrollItems = menuItems.map(function() {
|
57
|
+
var item = $($(this).attr("href"));
|
58
|
+
if (item.length) {
|
59
|
+
return item;
|
60
|
+
}
|
61
|
+
});
|
62
|
+
});
|
63
|
+
|
64
|
+
// Bind to scroll
|
65
|
+
$(window).scroll(function(){
|
66
|
+
// Get container scroll position
|
67
|
+
var fromTop = $(this).scrollTop() + 50;
|
68
|
+
|
69
|
+
// Get id of current scroll item
|
70
|
+
var cur = scrollItems.map(function() {
|
71
|
+
if ($(this).offset().top < fromTop) {
|
72
|
+
return this;
|
73
|
+
}
|
74
|
+
});
|
75
|
+
// Get the id of the current element
|
76
|
+
cur = cur[cur.length-1];
|
77
|
+
var id = cur && cur.length ? cur[0].id : "";
|
78
|
+
|
79
|
+
if (lastId !== id) {
|
80
|
+
lastId = id;
|
81
|
+
// Set/remove active class
|
82
|
+
menuItems
|
83
|
+
.parent().removeClass("active")
|
84
|
+
.end().filter("[href='#"+id+"']").parent().addClass("active");
|
85
|
+
}
|
86
|
+
});
|
87
|
+
});
|
metadata
ADDED
@@ -0,0 +1,117 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: jekyll-theme-gh-readme
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Olivier Poitrey
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-09-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: jekyll
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3.5'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.5'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: jekyll-seo-tag
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: html-proofer
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rubocop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0.50'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0.50'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: w3c_validators
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '1.3'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '1.3'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- rs@rhapsodyk.net
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- _layouts/default.html
|
91
|
+
- assets/main.css
|
92
|
+
- assets/nav.js
|
93
|
+
homepage: https://github.com/rs/gh-readme
|
94
|
+
licenses:
|
95
|
+
- MIT
|
96
|
+
metadata: {}
|
97
|
+
post_install_message:
|
98
|
+
rdoc_options: []
|
99
|
+
require_paths:
|
100
|
+
- lib
|
101
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
requirements: []
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 2.5.2.3
|
114
|
+
signing_key:
|
115
|
+
specification_version: 4
|
116
|
+
summary: gh-readme is a Jekyll theme for GitHub Pages
|
117
|
+
test_files: []
|