github-docs 0.0.4 → 0.0.17

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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/_layouts/default.html +17 -2
  3. data/assets/css/index.scss +9 -7
  4. data/readme.md +32 -25
  5. metadata +29 -62
  6. data/_sass/github-docs.scss +0 -227
  7. data/_sass/primer-base/base.scss +0 -84
  8. data/_sass/primer-base/index.scss +0 -3
  9. data/_sass/primer-base/normalize.scss +0 -421
  10. data/_sass/primer-base/typography-base.scss +0 -86
  11. data/_sass/primer-layout/columns.scss +0 -54
  12. data/_sass/primer-layout/container.scss +0 -30
  13. data/_sass/primer-layout/grid-offset.scss +0 -19
  14. data/_sass/primer-layout/grid.scss +0 -64
  15. data/_sass/primer-layout/index.scss +0 -4
  16. data/_sass/primer-markdown/blob-csv.scss +0 -27
  17. data/_sass/primer-markdown/code.scss +0 -63
  18. data/_sass/primer-markdown/headings.scss +0 -65
  19. data/_sass/primer-markdown/images.scss +0 -119
  20. data/_sass/primer-markdown/index.scss +0 -7
  21. data/_sass/primer-markdown/lists.scss +0 -76
  22. data/_sass/primer-markdown/markdown-body.scss +0 -106
  23. data/_sass/primer-markdown/tables.scss +0 -33
  24. data/_sass/primer-support/index.scss +0 -11
  25. data/_sass/primer-support/mixins/buttons.scss +0 -160
  26. data/_sass/primer-support/mixins/layout.scss +0 -58
  27. data/_sass/primer-support/mixins/misc.scss +0 -29
  28. data/_sass/primer-support/mixins/typography.scss +0 -84
  29. data/_sass/primer-support/variables/color-system.scss +0 -114
  30. data/_sass/primer-support/variables/colors.scss +0 -67
  31. data/_sass/primer-support/variables/layout.scss +0 -78
  32. data/_sass/primer-support/variables/misc.scss +0 -40
  33. data/_sass/primer-support/variables/typography.scss +0 -43
  34. data/_sass/primer-utilities/animations.scss +0 -184
  35. data/_sass/primer-utilities/borders.scss +0 -100
  36. data/_sass/primer-utilities/box-shadow.scss +0 -26
  37. data/_sass/primer-utilities/colors.scss +0 -106
  38. data/_sass/primer-utilities/details.scss +0 -18
  39. data/_sass/primer-utilities/flexbox.scss +0 -52
  40. data/_sass/primer-utilities/index.scss +0 -13
  41. data/_sass/primer-utilities/layout.scss +0 -85
  42. data/_sass/primer-utilities/margin.scss +0 -53
  43. data/_sass/primer-utilities/padding.scss +0 -54
  44. data/_sass/primer-utilities/typography.scss +0 -215
  45. data/_sass/primer-utilities/visibility-display.scss +0 -87
  46. data/_sass/rouge.scss +0 -209
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6499657a218c8899f4f7faaf1da9e4381c87885d49da21d13fef25b189190bf8
4
- data.tar.gz: e4a06cf64083d792c12cccbdbbfb7179232c1cd562311bf95df1f28c28c3ff84
3
+ metadata.gz: 0e5caa79900ec6cb060aed3775e4d9a21ceb4827181cd6ef04f4a4f8b6c37ff8
4
+ data.tar.gz: 27b1484dc6354daabe6c8bad6cc9951b83aa425b7aac3d5157b09a46050ee73b
5
5
  SHA512:
6
- metadata.gz: 21106a6d1f81af6793edc05870a9122c929bb6a8e7ab6999b8f2a229eabe848e37912787e2d584164a98d7e0de8f940e0d37273aa34ed175d2460c87b37cec4f
7
- data.tar.gz: bcb4a87ed7105678bd76140909bd51d2142d4b2a3499b4d84d2048892149dc005e29fd8037cd760d31381b6b5b099b4285668c3db6c2f208e46cd08bfd7031e9
6
+ metadata.gz: 1c834f68656f56f998b6b8ae11318d41b65c374f75dea9c87d8c8cf7aa02a2cb24d0e78b3ab0a73dc11d0363535ee815e929a15bf4d01801caaa35311170428a
7
+ data.tar.gz: 22a9073e61410596b1e86a616022c4b47226504c3f2d4e5234f0d962545d82ed8522467c7e13d795adcbb9321ce3aee55eb03a35c3aa3eab44c7027cf22361bd
@@ -12,12 +12,26 @@
12
12
  </head>
13
13
  <body>
14
14
  <div class="docs">
15
+ <!-- Sidebar -->
15
16
  <div class="sidebar">
16
17
  {% include sidebar.html %}
17
18
  </div>
18
- <div class="content">
19
- <div class="content-body p-6 markdown-body">
19
+
20
+ <!-- Content -->
21
+ <div class="main">
22
+ <div class="main-body markdown-body">
23
+ <!-- Edit button -->
24
+ {% if site.github_url != nil and site.github_url != "" %}
25
+ <a href="{{ site.github_url }}/edit/master/{% if site.basedir %}{{ site.basedir }}/{% endif %}{{ page.path }}"
26
+ class="main-edit-pencil">
27
+ <svg aria-hidden="true" viewBox="0 0 16 16" version="1.1" height="16" width="16">
28
+ <path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
29
+ </svg>
30
+ </a>
31
+ {% endif %}
32
+ <!-- Main content -->
20
33
  {{ content | replace: '<a href="http', '<a rel="nofollow noopener noreferrer" target="_blank" href="http' }}
34
+ <!-- Footer naviagtion -->
21
35
  {% if page.has_children == true and page.has_toc != false %}
22
36
  <hr>
23
37
  <h2 class="text-delta">Table of contents</h2>
@@ -36,6 +50,7 @@
36
50
  </div>
37
51
  </div>
38
52
  </div>
53
+
39
54
  <script src="{{ "/assets/js/anchor.min.js?1" | relative_url }}"></script>
40
55
  <script src="{{ "/assets/js/index.js?1" | relative_url }}"></script>
41
56
  <script>anchors.add();</script>
@@ -2,15 +2,17 @@
2
2
  # this ensures Jekyll reads the file to be transformed into CSS later
3
3
  # only Main files contain this front matter, not partials.
4
4
  ---
5
+ @charset "utf-8";
5
6
 
6
7
  {% if site.logo %}
7
8
  $logo: "{{ site.logo | absolute_url }}";
8
9
  {% endif %}
9
10
 
10
- @import "primer-support/index.scss";
11
- @import "primer-base/index.scss";
12
- @import "primer-utilities/index.scss";
13
- @import "primer-layout/index.scss";
14
- @import "primer-markdown/index.scss";
15
- @import "github-docs";
16
- @import "rouge";
11
+ // Cherry variables
12
+ $body-font-size: 14px;
13
+ $body-line-height: 1.65em;
14
+ $family-primary: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,
15
+ "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
16
+
17
+ // Load modules
18
+ @import "primer-markdown", "cherry", "main", "rouge";
data/readme.md CHANGED
@@ -4,34 +4,41 @@ A Jekyll theme for Github styled documentation
4
4
 
5
5
  ### Theme usage
6
6
 
7
- Add a _config.yml file with this line:
8
- ```yaml
9
- remote_theme: boycce/github-docs
10
- ```
11
-
12
- ### Preview theme locally via github-pages
13
-
14
- Add a Gemfile in your documention root
15
- ```ruby
16
- source 'https://rubygems.org'
17
- gem 'github-pages', group: :jekyll_plugins
18
- ```
19
-
20
- then update `github-pages` and the `theme`
21
- ```
22
- $ bundle update
23
- ```
24
-
25
- run via
26
- ```
27
- $ bundle exec jekyll serve
28
- ```
7
+ 1. To use this theme in your project via `github-pages`, add a _config.yml file with this line
8
+ ```yaml
9
+ remote_theme: boycce/github-docs
10
+ ```
11
+
12
+ ### Theme preview
13
+
14
+ 1. To preview this theme in your project via `github-pages`, add a Gemfile in your root folder
15
+ ```ruby
16
+ # (old)
17
+ # source 'https://rubygems.org'
18
+ # gem 'github-pages', group: :jekyll_plugins
19
+
20
+ # Below pulls the latest remote_theme in development
21
+ source 'https://rubygems.org'
22
+ gem "github-docs", git: "https://github.com/boycce/github-docs"
23
+ group :jekyll_plugins do
24
+ gem "jekyll-remote-theme", "~> 0.4.2"
25
+ end
26
+ ```
27
+ 2. Then update `github-pages` and the `theme`
28
+ ```
29
+ $ bundle install // or bundle update
30
+ ```
31
+ 3. And run
32
+ ```
33
+ $ bundle exec jekyll serve
34
+ ```
29
35
 
30
36
  ### Development
31
37
 
32
- 1. `$ gem install bundler`
33
- 2. `$ bundle install` (install theme deps)
34
- 3. `$ jekyll serve`
38
+ 1. Install rvm/ruby `^2.7.3` if not having done so already
39
+ 2.a. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
40
+ 2.b. `$ bundle install` (install theme deps automatically)
41
+ 4. `$ jekyll serve`
35
42
 
36
43
  ### Publishing Gem
37
44
 
metadata CHANGED
@@ -1,77 +1,85 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: github-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.0.17
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Boyce
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-18 00:00:00.000000000 Z
11
+ date: 2021-07-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 2.1.4
19
+ version: '0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: 2.1.4
26
+ version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: jekyll
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - ">="
32
- - !ruby/object:Gem::Version
33
- version: '3.5'
34
- - - "<"
31
+ - - "~>"
35
32
  - !ruby/object:Gem::Version
36
- version: '5.0'
33
+ version: 3.9.0
37
34
  type: :runtime
38
35
  prerelease: false
39
36
  version_requirements: !ruby/object:Gem::Requirement
40
37
  requirements:
41
- - - ">="
42
- - !ruby/object:Gem::Version
43
- version: '3.5'
44
- - - "<"
38
+ - - "~>"
45
39
  - !ruby/object:Gem::Version
46
- version: '5.0'
40
+ version: 3.9.0
47
41
  - !ruby/object:Gem::Dependency
48
42
  name: jekyll-github-metadata
49
43
  requirement: !ruby/object:Gem::Requirement
50
44
  requirements:
51
45
  - - "~>"
52
46
  - !ruby/object:Gem::Version
53
- version: '2.9'
47
+ version: 2.13.0
54
48
  type: :runtime
55
49
  prerelease: false
56
50
  version_requirements: !ruby/object:Gem::Requirement
57
51
  requirements:
58
52
  - - "~>"
59
53
  - !ruby/object:Gem::Version
60
- version: '2.9'
54
+ version: 2.13.0
61
55
  - !ruby/object:Gem::Dependency
62
56
  name: jekyll-seo-tag
63
57
  requirement: !ruby/object:Gem::Requirement
64
58
  requirements:
65
59
  - - "~>"
66
60
  - !ruby/object:Gem::Version
67
- version: '2.0'
61
+ version: 2.7.1
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.7.1
69
+ - !ruby/object:Gem::Dependency
70
+ name: kramdown-parser-gfm
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 1.1.0
68
76
  type: :runtime
69
77
  prerelease: false
70
78
  version_requirements: !ruby/object:Gem::Requirement
71
79
  requirements:
72
80
  - - "~>"
73
81
  - !ruby/object:Gem::Version
74
- version: '2.0'
82
+ version: 1.1.0
75
83
  description:
76
84
  email:
77
85
  - example@email.com
@@ -84,47 +92,6 @@ files:
84
92
  - _layouts/home.html
85
93
  - _layouts/page.html
86
94
  - _layouts/post.html
87
- - _sass/github-docs.scss
88
- - _sass/primer-base/base.scss
89
- - _sass/primer-base/index.scss
90
- - _sass/primer-base/normalize.scss
91
- - _sass/primer-base/typography-base.scss
92
- - _sass/primer-layout/columns.scss
93
- - _sass/primer-layout/container.scss
94
- - _sass/primer-layout/grid-offset.scss
95
- - _sass/primer-layout/grid.scss
96
- - _sass/primer-layout/index.scss
97
- - _sass/primer-markdown/blob-csv.scss
98
- - _sass/primer-markdown/code.scss
99
- - _sass/primer-markdown/headings.scss
100
- - _sass/primer-markdown/images.scss
101
- - _sass/primer-markdown/index.scss
102
- - _sass/primer-markdown/lists.scss
103
- - _sass/primer-markdown/markdown-body.scss
104
- - _sass/primer-markdown/tables.scss
105
- - _sass/primer-support/index.scss
106
- - _sass/primer-support/mixins/buttons.scss
107
- - _sass/primer-support/mixins/layout.scss
108
- - _sass/primer-support/mixins/misc.scss
109
- - _sass/primer-support/mixins/typography.scss
110
- - _sass/primer-support/variables/color-system.scss
111
- - _sass/primer-support/variables/colors.scss
112
- - _sass/primer-support/variables/layout.scss
113
- - _sass/primer-support/variables/misc.scss
114
- - _sass/primer-support/variables/typography.scss
115
- - _sass/primer-utilities/animations.scss
116
- - _sass/primer-utilities/borders.scss
117
- - _sass/primer-utilities/box-shadow.scss
118
- - _sass/primer-utilities/colors.scss
119
- - _sass/primer-utilities/details.scss
120
- - _sass/primer-utilities/flexbox.scss
121
- - _sass/primer-utilities/index.scss
122
- - _sass/primer-utilities/layout.scss
123
- - _sass/primer-utilities/margin.scss
124
- - _sass/primer-utilities/padding.scss
125
- - _sass/primer-utilities/typography.scss
126
- - _sass/primer-utilities/visibility-display.scss
127
- - _sass/rouge.scss
128
95
  - assets/css/index.scss
129
96
  - assets/imgs/back.svg
130
97
  - assets/js/anchor.min.js
@@ -149,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
149
116
  - !ruby/object:Gem::Version
150
117
  version: '0'
151
118
  requirements: []
152
- rubygems_version: 3.0.6
119
+ rubygems_version: 3.1.6
153
120
  signing_key:
154
121
  specification_version: 4
155
122
  summary: A Jekyll theme for Github styled documentation
@@ -1,227 +0,0 @@
1
- $sidebar-width: 250px;
2
- $sidebar-bg: #f8f8fb; //rgba(#f5f5fa, 0.7);
3
- $sidebar-heading-height: 80px;
4
- $menu-color: #483973;
5
-
6
- /* --- Main -------------------------- */
7
-
8
- .docs {
9
- max-width: 1400px;
10
- margin: 0 auto;
11
- }
12
- .content {
13
- display: block;
14
- margin-left: $sidebar-width;
15
- }
16
- .content-heading {
17
- display: block;
18
- }
19
- .content-body {
20
- display: block;
21
- max-width: 890px;
22
- margin: 0 auto;
23
- padding-top: 3em !important;
24
- }
25
- @media (max-width: 800px) {
26
- .content {
27
- margin-left: 0;
28
- }
29
- }
30
-
31
- /* --- Sidebar ----------------------- */
32
-
33
- .sidebar {
34
- position: fixed;
35
- top: 0;
36
- width: $sidebar-width;
37
- height: 100vh;
38
- background: $sidebar-bg;
39
- border-right: 1px solid darken($sidebar-bg, 3%);
40
- z-index: 2;
41
- }
42
- .sidebar:after {
43
- content: "";
44
- position: absolute;
45
- top: 0;
46
- left: -10000px;
47
- right: 100%;
48
- bottom: 0;
49
- background: $sidebar-bg;
50
- }
51
- .sidebar-heading {
52
- height: $sidebar-heading-height;
53
- display: flex;
54
- align-items: center;
55
- justify-content: space-between;
56
- border-bottom: 1px solid #eee;
57
- font-family: 'Roboto', sans-serif;
58
- font-size: 1.5em;
59
- font-weight: 900;
60
- letter-spacing: -0.5px;
61
- }
62
- .sidebar-heading a {
63
- color: #232035;
64
- text-decoration: none;
65
- }
66
- .sidebar-heading button {
67
- flex: 0;
68
- padding: 9px 25px;
69
- font-size: 14px;
70
- font-weight: 600;
71
- color: #fff;
72
- background-color: #483973;
73
- border-radius: 3px;
74
- border: 0;
75
- box-shadow: 0 4px 6px rgba(50,50,93,0.11), 0 1px 3px rgba(0,0,0,0.08);
76
- transition: box-shadow 0.2s ease;
77
- }
78
- .sidebar-heading button:hover {
79
- box-shadow: 0 4px 6px rgba(50,50,93,0.3), 0 1px 3px rgba(0,0,0,0.3);
80
- }
81
- .sidebar-close,
82
- .sidebar-heading,
83
- .navigation-list-link {
84
- padding-left: 30px;
85
- padding-right: 30px;
86
- }
87
- .sidebar-nav {
88
- position: relative;
89
- z-index: 11;
90
- padding: 0px 1px;
91
- }
92
-
93
- /* sidebar heading mobile */
94
-
95
- .sidebar-heading-mobile {
96
- border-bottom: 1px solid #eee;
97
- }
98
- .sidebar-close {
99
- display: flex;
100
- align-items: center;
101
- height: $sidebar-heading-height - 10px;
102
- cursor: pointer;
103
- padding: 0 25px;
104
- }
105
- .sidebar-close img {
106
- width: 22px;
107
- margin-left: -2px;
108
- }
109
- .sidebar-close:hover {
110
-
111
- }
112
- @media (max-width: 800px) {
113
- .sidebar {
114
- position: static;
115
- top: auto;
116
- width: 100%;
117
- height: auto;
118
- background: none;
119
- }
120
- .sidebar-nav {
121
- position: fixed;
122
- left: -$sidebar-width;
123
- top: 0;
124
- width: $sidebar-width;
125
- height: 100vh;
126
- background: $sidebar-bg;
127
- border-right: 1px solid darken($sidebar-bg, 3%);
128
- box-shadow: rgba(0, 0, 0, 0.14) 0px 0px 4px, rgba(0, 0, 0, 0.28) 0px 4px 8px;
129
- transition: transform 400ms cubic-bezier(0.4, 0, 0, 1);
130
- transform: translate(0, 0);
131
- }
132
- .sidebar-heading,
133
- .sidebar-close,
134
- .navigation-list-link {
135
- padding-left: 40px;
136
- padding-right: 40px;
137
- }
138
- .sidebar-overlay {
139
- position: fixed;
140
- top: 0;
141
- left: 0;
142
- right: 100%;
143
- bottom: 0;
144
- z-index: 0;
145
- opacity: 0;
146
- background-color: rgba(24, 48, 85, 0.3);
147
- transition: opacity 250ms ease-in-out, right 0s 250ms;
148
- }
149
- .nav-open .sidebar-nav {
150
- transform: translate($sidebar-width, 0);
151
- }
152
- .nav-open .sidebar-overlay {
153
- transition: opacity 250ms ease-in-out;
154
- right: 0;
155
- opacity: 1;
156
- }
157
- }
158
- @media (min-width: 801px) {
159
- .mobile-only {
160
- display: none;
161
- }
162
- .sidebar-overlay {
163
- display: none;
164
- }
165
- }
166
-
167
- /* --- Navigation -------------------- */
168
-
169
- .navigation-list {
170
- padding: 20px 0;
171
- display: block;
172
- list-style: none;
173
- }
174
- .navigation-list-link {
175
- position: relative;
176
- display: block;
177
- padding-top: 5px;
178
- padding-bottom: 5px;
179
- color: $menu-color;
180
- font-size: 1.1em;
181
- }
182
- .navigation-list-link.active,
183
- .navigation-list-link:hover {
184
- text-decoration: none;
185
- color: darken($menu-color, 40%);
186
- }
187
- .navigation-list-link:before {
188
- content: "";
189
- position: absolute;
190
- display: block;
191
- top: 50%;
192
- left: 0;
193
- height: 18px;
194
- width: 4px;
195
- margin-top: -9px;
196
- background-color: transparent;
197
- border-radius: 3px;
198
- transform: translateX(-3px);
199
- transition: all 0.2s ease;
200
- }
201
- .navigation-list-link.active:before,
202
- .navigation-list-link:hover:before {
203
- background-color: $menu-color;
204
- transform: translateX(0);
205
- }
206
-
207
- /* submenu */
208
-
209
- .navigation-list ul {
210
- padding-left: 0;
211
- display: block;
212
- list-style: none;
213
- }
214
- .navigation-list ul .navigation-list-link {
215
- padding-left: 50px;
216
- }
217
-
218
- /* aux navigation */
219
-
220
- .navigation-list-aux {
221
- padding: 0 0 20px;
222
- display: block;
223
- list-style: none;
224
- }
225
- .navigation-list-aux .navigation-list-link:before {
226
- display: none;
227
- }