github-docs 0.0.17 → 0.0.21
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/_sass/cherry/_base-normalize.scss +274 -0
- data/_sass/cherry/_buttons.scss +305 -0
- data/_sass/cherry/_columns.scss +220 -0
- data/_sass/cherry/_elements.scss +339 -0
- data/_sass/cherry/_forms-vue-select.scss +250 -0
- data/_sass/cherry/_forms.scss +567 -0
- data/_sass/cherry/_functions.scss +201 -0
- data/_sass/cherry/_index.scss +14 -0
- data/_sass/cherry/_layout.scss +207 -0
- data/_sass/cherry/_modal.scss +82 -0
- data/_sass/cherry/_spacing.scss +56 -0
- data/_sass/cherry/_tooltips.scss +113 -0
- data/_sass/cherry/_typography.scss +90 -0
- data/_sass/cherry/_utilities.scss +552 -0
- data/_sass/cherry/_variables-computed.scss +79 -0
- data/_sass/cherry/_variables.scss +48 -0
- data/_sass/main.scss +256 -0
- data/_sass/primer-markdown/blob-csv.scss +25 -0
- data/_sass/primer-markdown/code.scss +49 -0
- data/_sass/primer-markdown/headings.scss +51 -0
- data/_sass/primer-markdown/images.scss +101 -0
- data/_sass/primer-markdown/index.scss +118 -0
- data/_sass/primer-markdown/lists.scss +42 -0
- data/_sass/primer-markdown/tables.scss +28 -0
- data/_sass/rouge.scss +217 -0
- data/assets/css/index.scss +0 -0
- data/readme.md +10 -8
- metadata +97 -24
data/_sass/rouge.scss
ADDED
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
.highlight {
|
|
2
|
+
background-color: #f8f8f8;
|
|
3
|
+
table td {
|
|
4
|
+
padding: 5px;
|
|
5
|
+
}
|
|
6
|
+
table pre {
|
|
7
|
+
margin: 0;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
.highlight .cm {
|
|
11
|
+
color: #999988;
|
|
12
|
+
font-style: italic;
|
|
13
|
+
}
|
|
14
|
+
.highlight .cp {
|
|
15
|
+
color: #999999;
|
|
16
|
+
font-weight: bold;
|
|
17
|
+
}
|
|
18
|
+
.highlight .c1 {
|
|
19
|
+
color: #999988;
|
|
20
|
+
font-style: italic;
|
|
21
|
+
}
|
|
22
|
+
.highlight .cs {
|
|
23
|
+
color: #999999;
|
|
24
|
+
font-weight: bold;
|
|
25
|
+
font-style: italic;
|
|
26
|
+
}
|
|
27
|
+
.highlight .c,
|
|
28
|
+
.highlight .cd {
|
|
29
|
+
color: #999988;
|
|
30
|
+
font-style: italic;
|
|
31
|
+
}
|
|
32
|
+
.highlight .err {
|
|
33
|
+
color: #a61717;
|
|
34
|
+
background-color: #e3d2d2;
|
|
35
|
+
}
|
|
36
|
+
.highlight .gd {
|
|
37
|
+
color: #000000;
|
|
38
|
+
background-color: #ffdddd;
|
|
39
|
+
}
|
|
40
|
+
.highlight .ge {
|
|
41
|
+
color: #000000;
|
|
42
|
+
font-style: italic;
|
|
43
|
+
}
|
|
44
|
+
.highlight .gr {
|
|
45
|
+
color: #aa0000;
|
|
46
|
+
}
|
|
47
|
+
.highlight .gh {
|
|
48
|
+
color: #999999;
|
|
49
|
+
}
|
|
50
|
+
.highlight .gi {
|
|
51
|
+
color: #000000;
|
|
52
|
+
background-color: #ddffdd;
|
|
53
|
+
}
|
|
54
|
+
.highlight .go {
|
|
55
|
+
color: #888888;
|
|
56
|
+
}
|
|
57
|
+
.highlight .gp {
|
|
58
|
+
color: #555555;
|
|
59
|
+
}
|
|
60
|
+
.highlight .gs {
|
|
61
|
+
font-weight: bold;
|
|
62
|
+
}
|
|
63
|
+
.highlight .gu {
|
|
64
|
+
color: #aaaaaa;
|
|
65
|
+
}
|
|
66
|
+
.highlight .gt {
|
|
67
|
+
color: #aa0000;
|
|
68
|
+
}
|
|
69
|
+
.highlight .kc {
|
|
70
|
+
color: #000000;
|
|
71
|
+
font-weight: bold;
|
|
72
|
+
}
|
|
73
|
+
.highlight .kd {
|
|
74
|
+
color: #000000;
|
|
75
|
+
font-weight: bold;
|
|
76
|
+
}
|
|
77
|
+
.highlight .kn {
|
|
78
|
+
color: #000000;
|
|
79
|
+
font-weight: bold;
|
|
80
|
+
}
|
|
81
|
+
.highlight .kp {
|
|
82
|
+
color: #000000;
|
|
83
|
+
font-weight: bold;
|
|
84
|
+
}
|
|
85
|
+
.highlight .kr {
|
|
86
|
+
color: #000000;
|
|
87
|
+
font-weight: bold;
|
|
88
|
+
}
|
|
89
|
+
.highlight .kt {
|
|
90
|
+
color: #445588;
|
|
91
|
+
font-weight: bold;
|
|
92
|
+
}
|
|
93
|
+
.highlight .k,
|
|
94
|
+
.highlight .kv {
|
|
95
|
+
color: #000000;
|
|
96
|
+
font-weight: bold;
|
|
97
|
+
}
|
|
98
|
+
.highlight .mf {
|
|
99
|
+
color: #009999;
|
|
100
|
+
}
|
|
101
|
+
.highlight .mh {
|
|
102
|
+
color: #009999;
|
|
103
|
+
}
|
|
104
|
+
.highlight .il {
|
|
105
|
+
color: #009999;
|
|
106
|
+
}
|
|
107
|
+
.highlight .mi {
|
|
108
|
+
color: #009999;
|
|
109
|
+
}
|
|
110
|
+
.highlight .mo {
|
|
111
|
+
color: #009999;
|
|
112
|
+
}
|
|
113
|
+
.highlight .m,
|
|
114
|
+
.highlight .mb,
|
|
115
|
+
.highlight .mx {
|
|
116
|
+
color: #009999;
|
|
117
|
+
}
|
|
118
|
+
.highlight .sb {
|
|
119
|
+
color: #d14;
|
|
120
|
+
}
|
|
121
|
+
.highlight .sc {
|
|
122
|
+
color: #d14;
|
|
123
|
+
}
|
|
124
|
+
.highlight .sd {
|
|
125
|
+
color: #d14;
|
|
126
|
+
}
|
|
127
|
+
.highlight .s2 {
|
|
128
|
+
color: #d14;
|
|
129
|
+
}
|
|
130
|
+
.highlight .se {
|
|
131
|
+
color: #d14;
|
|
132
|
+
}
|
|
133
|
+
.highlight .sh {
|
|
134
|
+
color: #d14;
|
|
135
|
+
}
|
|
136
|
+
.highlight .si {
|
|
137
|
+
color: #d14;
|
|
138
|
+
}
|
|
139
|
+
.highlight .sx {
|
|
140
|
+
color: #d14;
|
|
141
|
+
}
|
|
142
|
+
.highlight .sr {
|
|
143
|
+
color: #009926;
|
|
144
|
+
}
|
|
145
|
+
.highlight .s1 {
|
|
146
|
+
color: #d14;
|
|
147
|
+
}
|
|
148
|
+
.highlight .ss {
|
|
149
|
+
color: #990073;
|
|
150
|
+
}
|
|
151
|
+
.highlight .s {
|
|
152
|
+
color: #d14;
|
|
153
|
+
}
|
|
154
|
+
.highlight .na {
|
|
155
|
+
color: #008080;
|
|
156
|
+
}
|
|
157
|
+
.highlight .bp {
|
|
158
|
+
color: #999999;
|
|
159
|
+
}
|
|
160
|
+
.highlight .nb {
|
|
161
|
+
color: #0086B3;
|
|
162
|
+
}
|
|
163
|
+
.highlight .nc {
|
|
164
|
+
color: #445588;
|
|
165
|
+
font-weight: bold;
|
|
166
|
+
}
|
|
167
|
+
.highlight .no {
|
|
168
|
+
color: #008080;
|
|
169
|
+
}
|
|
170
|
+
.highlight .nd {
|
|
171
|
+
color: #3c5d5d;
|
|
172
|
+
font-weight: bold;
|
|
173
|
+
}
|
|
174
|
+
.highlight .ni {
|
|
175
|
+
color: #800080;
|
|
176
|
+
}
|
|
177
|
+
.highlight .ne {
|
|
178
|
+
color: #990000;
|
|
179
|
+
font-weight: bold;
|
|
180
|
+
}
|
|
181
|
+
.highlight .nf {
|
|
182
|
+
color: #990000;
|
|
183
|
+
font-weight: bold;
|
|
184
|
+
}
|
|
185
|
+
.highlight .nl {
|
|
186
|
+
color: #990000;
|
|
187
|
+
font-weight: bold;
|
|
188
|
+
}
|
|
189
|
+
.highlight .nn {
|
|
190
|
+
color: #555555;
|
|
191
|
+
}
|
|
192
|
+
.highlight .nt {
|
|
193
|
+
color: #000080;
|
|
194
|
+
}
|
|
195
|
+
.highlight .vc {
|
|
196
|
+
color: #008080;
|
|
197
|
+
}
|
|
198
|
+
.highlight .vg {
|
|
199
|
+
color: #008080;
|
|
200
|
+
}
|
|
201
|
+
.highlight .vi {
|
|
202
|
+
color: #008080;
|
|
203
|
+
}
|
|
204
|
+
.highlight .nv {
|
|
205
|
+
color: #008080;
|
|
206
|
+
}
|
|
207
|
+
.highlight .ow {
|
|
208
|
+
color: #000000;
|
|
209
|
+
font-weight: bold;
|
|
210
|
+
}
|
|
211
|
+
.highlight .o {
|
|
212
|
+
color: #000000;
|
|
213
|
+
font-weight: bold;
|
|
214
|
+
}
|
|
215
|
+
.highlight .w {
|
|
216
|
+
color: #bbbbbb;
|
|
217
|
+
}
|
data/assets/css/index.scss
CHANGED
|
File without changes
|
data/readme.md
CHANGED
|
@@ -9,16 +9,16 @@ A Jekyll theme for Github styled documentation
|
|
|
9
9
|
remote_theme: boycce/github-docs
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
### Theme preview
|
|
12
|
+
### Theme local preview
|
|
13
13
|
|
|
14
14
|
1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
|
|
15
15
|
```ruby
|
|
16
|
+
source 'https://rubygems.org'
|
|
17
|
+
|
|
16
18
|
# (old)
|
|
17
|
-
# source 'https://rubygems.org'
|
|
18
19
|
# gem 'github-pages', group: :jekyll_plugins
|
|
19
20
|
|
|
20
|
-
# Below pulls the latest remote_theme in development
|
|
21
|
-
source 'https://rubygems.org'
|
|
21
|
+
# Below pulls the latest remote_theme in development (https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages)
|
|
22
22
|
gem "github-docs", git: "https://github.com/boycce/github-docs"
|
|
23
23
|
group :jekyll_plugins do
|
|
24
24
|
gem "jekyll-remote-theme", "~> 0.4.2"
|
|
@@ -26,7 +26,7 @@ A Jekyll theme for Github styled documentation
|
|
|
26
26
|
```
|
|
27
27
|
2. Then update `github-pages` and the `theme`
|
|
28
28
|
```
|
|
29
|
-
$ bundle install //
|
|
29
|
+
$ bundle install // bundle update to refresh gems
|
|
30
30
|
```
|
|
31
31
|
3. And run
|
|
32
32
|
```
|
|
@@ -36,11 +36,13 @@ A Jekyll theme for Github styled documentation
|
|
|
36
36
|
### Development
|
|
37
37
|
|
|
38
38
|
1. Install rvm/ruby `^2.7.3` if not having done so already
|
|
39
|
-
2.a
|
|
40
|
-
|
|
41
|
-
4. `$ jekyll serve`
|
|
39
|
+
2. (a) `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
|
|
40
|
+
3. (b) `$ bundle install` (install theme deps automatically)
|
|
41
|
+
4. `$ jekyll serve --port 4001`
|
|
42
42
|
|
|
43
43
|
### Publishing Gem
|
|
44
44
|
|
|
45
45
|
1. `$ gem build github-docs.gemspec`
|
|
46
46
|
2. `$ gem push github-docs-*.gem`
|
|
47
|
+
or
|
|
48
|
+
1. `$ rm ./*.gem 2>/dev/null && gem build github-docs.gemspec && gem push github-docs-*.gem`
|
metadata
CHANGED
|
@@ -1,85 +1,133 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: github-docs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.21
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ricky Boyce
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2022-02-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
|
-
- !ruby/object:Gem::Dependency
|
|
14
|
-
name: bundler
|
|
15
|
-
requirement: !ruby/object:Gem::Requirement
|
|
16
|
-
requirements:
|
|
17
|
-
- - ">="
|
|
18
|
-
- !ruby/object:Gem::Version
|
|
19
|
-
version: '0'
|
|
20
|
-
type: :runtime
|
|
21
|
-
prerelease: false
|
|
22
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
-
requirements:
|
|
24
|
-
- - ">="
|
|
25
|
-
- !ruby/object:Gem::Version
|
|
26
|
-
version: '0'
|
|
27
13
|
- !ruby/object:Gem::Dependency
|
|
28
14
|
name: jekyll
|
|
29
15
|
requirement: !ruby/object:Gem::Requirement
|
|
30
16
|
requirements:
|
|
31
|
-
- -
|
|
17
|
+
- - '='
|
|
32
18
|
- !ruby/object:Gem::Version
|
|
33
19
|
version: 3.9.0
|
|
34
20
|
type: :runtime
|
|
35
21
|
prerelease: false
|
|
36
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
23
|
requirements:
|
|
38
|
-
- -
|
|
24
|
+
- - '='
|
|
39
25
|
- !ruby/object:Gem::Version
|
|
40
26
|
version: 3.9.0
|
|
41
27
|
- !ruby/object:Gem::Dependency
|
|
42
28
|
name: jekyll-github-metadata
|
|
43
29
|
requirement: !ruby/object:Gem::Requirement
|
|
44
30
|
requirements:
|
|
45
|
-
- -
|
|
31
|
+
- - '='
|
|
46
32
|
- !ruby/object:Gem::Version
|
|
47
33
|
version: 2.13.0
|
|
48
34
|
type: :runtime
|
|
49
35
|
prerelease: false
|
|
50
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
37
|
requirements:
|
|
52
|
-
- -
|
|
38
|
+
- - '='
|
|
53
39
|
- !ruby/object:Gem::Version
|
|
54
40
|
version: 2.13.0
|
|
55
41
|
- !ruby/object:Gem::Dependency
|
|
56
42
|
name: jekyll-seo-tag
|
|
57
43
|
requirement: !ruby/object:Gem::Requirement
|
|
58
44
|
requirements:
|
|
59
|
-
- -
|
|
45
|
+
- - '='
|
|
60
46
|
- !ruby/object:Gem::Version
|
|
61
47
|
version: 2.7.1
|
|
62
48
|
type: :runtime
|
|
63
49
|
prerelease: false
|
|
64
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
65
51
|
requirements:
|
|
66
|
-
- -
|
|
52
|
+
- - '='
|
|
67
53
|
- !ruby/object:Gem::Version
|
|
68
54
|
version: 2.7.1
|
|
69
55
|
- !ruby/object:Gem::Dependency
|
|
70
56
|
name: kramdown-parser-gfm
|
|
71
57
|
requirement: !ruby/object:Gem::Requirement
|
|
72
58
|
requirements:
|
|
73
|
-
- -
|
|
59
|
+
- - '='
|
|
74
60
|
- !ruby/object:Gem::Version
|
|
75
61
|
version: 1.1.0
|
|
76
62
|
type: :runtime
|
|
77
63
|
prerelease: false
|
|
78
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
79
65
|
requirements:
|
|
80
|
-
- -
|
|
66
|
+
- - '='
|
|
81
67
|
- !ruby/object:Gem::Version
|
|
82
68
|
version: 1.1.0
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: rake
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - ">="
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 12.3.1
|
|
76
|
+
- - "<"
|
|
77
|
+
- !ruby/object:Gem::Version
|
|
78
|
+
version: 13.1.0
|
|
79
|
+
type: :runtime
|
|
80
|
+
prerelease: false
|
|
81
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
82
|
+
requirements:
|
|
83
|
+
- - ">="
|
|
84
|
+
- !ruby/object:Gem::Version
|
|
85
|
+
version: 12.3.1
|
|
86
|
+
- - "<"
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: 13.1.0
|
|
89
|
+
- !ruby/object:Gem::Dependency
|
|
90
|
+
name: rouge
|
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - '='
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: 3.26.0
|
|
96
|
+
type: :runtime
|
|
97
|
+
prerelease: false
|
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - '='
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: 3.26.0
|
|
103
|
+
- !ruby/object:Gem::Dependency
|
|
104
|
+
name: jekyll-sass-converter
|
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - '='
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: 1.5.2
|
|
110
|
+
type: :runtime
|
|
111
|
+
prerelease: false
|
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - '='
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: 1.5.2
|
|
117
|
+
- !ruby/object:Gem::Dependency
|
|
118
|
+
name: bundler
|
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
|
120
|
+
requirements:
|
|
121
|
+
- - "~>"
|
|
122
|
+
- !ruby/object:Gem::Version
|
|
123
|
+
version: '2.0'
|
|
124
|
+
type: :development
|
|
125
|
+
prerelease: false
|
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
127
|
+
requirements:
|
|
128
|
+
- - "~>"
|
|
129
|
+
- !ruby/object:Gem::Version
|
|
130
|
+
version: '2.0'
|
|
83
131
|
description:
|
|
84
132
|
email:
|
|
85
133
|
- example@email.com
|
|
@@ -92,6 +140,31 @@ files:
|
|
|
92
140
|
- _layouts/home.html
|
|
93
141
|
- _layouts/page.html
|
|
94
142
|
- _layouts/post.html
|
|
143
|
+
- _sass/cherry/_base-normalize.scss
|
|
144
|
+
- _sass/cherry/_buttons.scss
|
|
145
|
+
- _sass/cherry/_columns.scss
|
|
146
|
+
- _sass/cherry/_elements.scss
|
|
147
|
+
- _sass/cherry/_forms-vue-select.scss
|
|
148
|
+
- _sass/cherry/_forms.scss
|
|
149
|
+
- _sass/cherry/_functions.scss
|
|
150
|
+
- _sass/cherry/_index.scss
|
|
151
|
+
- _sass/cherry/_layout.scss
|
|
152
|
+
- _sass/cherry/_modal.scss
|
|
153
|
+
- _sass/cherry/_spacing.scss
|
|
154
|
+
- _sass/cherry/_tooltips.scss
|
|
155
|
+
- _sass/cherry/_typography.scss
|
|
156
|
+
- _sass/cherry/_utilities.scss
|
|
157
|
+
- _sass/cherry/_variables-computed.scss
|
|
158
|
+
- _sass/cherry/_variables.scss
|
|
159
|
+
- _sass/main.scss
|
|
160
|
+
- _sass/primer-markdown/blob-csv.scss
|
|
161
|
+
- _sass/primer-markdown/code.scss
|
|
162
|
+
- _sass/primer-markdown/headings.scss
|
|
163
|
+
- _sass/primer-markdown/images.scss
|
|
164
|
+
- _sass/primer-markdown/index.scss
|
|
165
|
+
- _sass/primer-markdown/lists.scss
|
|
166
|
+
- _sass/primer-markdown/tables.scss
|
|
167
|
+
- _sass/rouge.scss
|
|
95
168
|
- assets/css/index.scss
|
|
96
169
|
- assets/imgs/back.svg
|
|
97
170
|
- assets/js/anchor.min.js
|