github-docs 0.0.5 → 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. checksums.yaml +4 -4
  2. data/_layouts/default.html +11 -4
  3. data/assets/css/cherry/_base-normalize.scss +274 -0
  4. data/assets/css/cherry/_buttons.scss +305 -0
  5. data/assets/css/cherry/_columns.scss +220 -0
  6. data/assets/css/cherry/_elements.scss +339 -0
  7. data/assets/css/cherry/_forms-vue-select.scss +250 -0
  8. data/assets/css/cherry/_forms.scss +567 -0
  9. data/assets/css/cherry/_functions.scss +201 -0
  10. data/assets/css/cherry/_index.scss +14 -0
  11. data/assets/css/cherry/_layout.scss +207 -0
  12. data/assets/css/cherry/_modal.scss +82 -0
  13. data/assets/css/cherry/_spacing.scss +56 -0
  14. data/assets/css/cherry/_tooltips.scss +113 -0
  15. data/assets/css/cherry/_typography.scss +90 -0
  16. data/assets/css/cherry/_utilities.scss +552 -0
  17. data/assets/css/cherry/_variables-computed.scss +79 -0
  18. data/assets/css/cherry/_variables.scss +48 -0
  19. data/assets/css/index.scss +9 -7
  20. data/{_sass/github-docs.scss → assets/css/main.scss} +18 -15
  21. data/assets/css/primer-markdown/blob-csv.scss +25 -0
  22. data/assets/css/primer-markdown/code.scss +49 -0
  23. data/{_sass → assets/css}/primer-markdown/headings.scss +5 -19
  24. data/{_sass → assets/css}/primer-markdown/images.scss +1 -19
  25. data/{_sass/primer-markdown/markdown-body.scss → assets/css/primer-markdown/index.scss} +66 -55
  26. data/assets/css/primer-markdown/lists.scss +42 -0
  27. data/{_sass → assets/css}/primer-markdown/tables.scss +4 -9
  28. data/{_sass → assets/css}/rouge.scss +16 -8
  29. data/readme.md +2 -2
  30. metadata +27 -43
  31. data/_sass/primer-base/base.scss +0 -84
  32. data/_sass/primer-base/index.scss +0 -3
  33. data/_sass/primer-base/normalize.scss +0 -421
  34. data/_sass/primer-base/typography-base.scss +0 -86
  35. data/_sass/primer-layout/columns.scss +0 -54
  36. data/_sass/primer-layout/container.scss +0 -30
  37. data/_sass/primer-layout/grid-offset.scss +0 -19
  38. data/_sass/primer-layout/grid.scss +0 -64
  39. data/_sass/primer-layout/index.scss +0 -4
  40. data/_sass/primer-markdown/blob-csv.scss +0 -27
  41. data/_sass/primer-markdown/code.scss +0 -63
  42. data/_sass/primer-markdown/index.scss +0 -7
  43. data/_sass/primer-markdown/lists.scss +0 -76
  44. data/_sass/primer-support/index.scss +0 -11
  45. data/_sass/primer-support/mixins/buttons.scss +0 -160
  46. data/_sass/primer-support/mixins/layout.scss +0 -58
  47. data/_sass/primer-support/mixins/misc.scss +0 -29
  48. data/_sass/primer-support/mixins/typography.scss +0 -84
  49. data/_sass/primer-support/variables/color-system.scss +0 -114
  50. data/_sass/primer-support/variables/colors.scss +0 -67
  51. data/_sass/primer-support/variables/layout.scss +0 -78
  52. data/_sass/primer-support/variables/misc.scss +0 -40
  53. data/_sass/primer-support/variables/typography.scss +0 -43
  54. data/_sass/primer-utilities/animations.scss +0 -184
  55. data/_sass/primer-utilities/borders.scss +0 -100
  56. data/_sass/primer-utilities/box-shadow.scss +0 -26
  57. data/_sass/primer-utilities/colors.scss +0 -106
  58. data/_sass/primer-utilities/details.scss +0 -18
  59. data/_sass/primer-utilities/flexbox.scss +0 -52
  60. data/_sass/primer-utilities/index.scss +0 -13
  61. data/_sass/primer-utilities/layout.scss +0 -85
  62. data/_sass/primer-utilities/margin.scss +0 -53
  63. data/_sass/primer-utilities/padding.scss +0 -54
  64. data/_sass/primer-utilities/typography.scss +0 -215
  65. data/_sass/primer-utilities/visibility-display.scss +0 -87
@@ -1,95 +1,67 @@
1
- // All of our block level items should have the same margin
2
- // stylelint-disable selector-max-type
1
+ $markdown-line-height: 1.5em;
2
+ $markdown-spacer-1: 4px;
3
+ $markdown-spacer-2: 8px;
4
+ $markdown-spacer-3: 16px;
5
+ $markdown-spacer-4: 24px;
6
+ $markdown-font-size-small: 12px;
7
+ $markdown-font-weight-bold: 600;
8
+
9
+ $gray-000: #fafbfc;
10
+ $gray-100: #f6f8fa;
11
+ $gray-200: #e1e4e8;
12
+ $gray-300: #d1d5da;
13
+ $gray-400: #959da5;
14
+ $gray-500: #6a737d;
15
+ $gray-700: #444d56;
3
16
 
4
- // This is styling for generic markdownized text. Anything you put in a
5
- // container with .markdown-body on it should render generally well. It also
6
- // includes some GitHub Flavored Markdown specific styling (like @mentions)
7
17
  .markdown-body {
8
- font-family: $body-font;
9
- font-size: $h4-size;
10
- line-height: $body-line-height;
18
+ font-size: 16px;
19
+ line-height: $markdown-line-height;
11
20
  word-wrap: break-word;
12
-
13
- // Clearfix on the markdown body
14
- &::before {
15
- display: table;
16
- content: "";
17
- }
18
-
21
+ color: #24292e;
19
22
  &::after {
20
- display: table;
23
+ display: block;
21
24
  clear: both;
22
25
  content: "";
23
26
  }
24
-
25
27
  > *:first-child {
26
28
  margin-top: 0 !important;
27
29
  }
28
-
29
30
  > *:last-child {
30
31
  margin-bottom: 0 !important;
31
32
  }
32
-
33
- // Anchors like <a name="examples">. These sometimes end up wrapped around
34
- // text when users mistakenly forget to close the tag or use self-closing tag
35
- // syntax. We don't want them to appear like links.
36
- // FIXME: a:not(:link):not(:visited) would be a little clearer here (and
37
- // possibly faster to match), but it breaks styling of <a href> elements due
38
- // to https://bugs.webkit.org/show_bug.cgi?id=142737.
39
- a:not([href]) {
40
- color: inherit;
41
- text-decoration: none;
42
- }
43
-
44
- // Link Colors
45
- .absent {
46
- color: $red-600;
47
- }
48
-
49
- .anchor {
50
- float: left;
51
- padding-right: $spacer-1;
52
- margin-left: -20px;
53
- line-height: $lh-condensed-ultra;
54
-
55
- &:focus {
56
- outline: none;
57
- }
58
- }
59
-
33
+ // Blocks
60
34
  p,
61
35
  blockquote,
62
36
  ul,
63
37
  ol,
64
38
  dl,
65
39
  table,
66
- pre {
40
+ pre,
41
+ .highlight {
67
42
  margin-top: 0;
68
- margin-bottom: $spacer-3;
43
+ margin-bottom: $markdown-spacer-3;
69
44
  }
70
-
71
45
  hr {
72
- height: $em-spacer-3;
46
+ height: 0.25em;
73
47
  padding: 0;
74
- margin: $spacer-4 0;
48
+ margin: $markdown-spacer-4 0;
75
49
  background-color: $gray-200;
76
50
  border: 0;
77
51
  }
78
-
79
52
  blockquote {
53
+ margin-left: 0;
54
+ margin-right: 0;
80
55
  padding: 0 1em;
81
56
  color: $gray-500;
82
57
  border-left: 0.25em solid lighten($gray-300, 5%);
83
-
84
58
  > :first-child {
85
59
  margin-top: 0;
86
60
  }
87
-
88
61
  > :last-child {
89
62
  margin-bottom: 0;
90
63
  }
91
64
  }
92
-
93
65
  kbd {
94
66
  display: inline-block;
95
67
  padding: 3px 5px;
@@ -103,4 +75,43 @@
103
75
  border-radius: 3px;
104
76
  box-shadow: inset 0 -1px 0 $gray-400;
105
77
  }
78
+ // Anchors like <a name="examples">. These sometimes end up wrapped around
79
+ // text when users mistakenly forget to close the tag or use self-closing tag
80
+ // syntax. We don't want them to appear like links.
81
+ a {
82
+ color: #0366d6;
83
+ text-decoration: none;
84
+ &:hover,
85
+ &:focus {
86
+ text-decoration: underline;
87
+ }
88
+ }
89
+ a:not([href]) {
90
+ color: inherit;
91
+ text-decoration: none;
92
+ }
93
+ // Links
94
+ .absent {
95
+ color: #cb2431;
96
+ }
97
+ .anchor,
98
+ .anchorjs-link {
99
+ float: left;
100
+ line-height: 1em;
101
+ font-size: 1.1em !important;
102
+ padding-right: 10px !important;
103
+ margin-left: calc(-1em - 10px) !important;
104
+ &:hover,
105
+ &:focus {
106
+ outline: none;
107
+ text-decoration: none;
108
+ }
109
+ }
106
110
  }
111
+
112
+ @import "./headings.scss";
113
+ @import "./lists.scss";
114
+ @import "./tables.scss";
115
+ @import "./images.scss";
116
+ @import "./code.scss";
117
+ @import "./blob-csv.scss";
@@ -0,0 +1,42 @@
1
+ .markdown-body {
2
+ ul,
3
+ ol {
4
+ padding-left: 2em;
5
+ &.no-list {
6
+ padding: 0;
7
+ list-style-type: none;
8
+ }
9
+ }
10
+ ul ul,
11
+ ul ol,
12
+ ol ol,
13
+ ol ul {
14
+ margin-top: 0;
15
+ margin-bottom: 0;
16
+ }
17
+ li {
18
+ word-wrap: break-all;
19
+ }
20
+ li > p {
21
+ margin-top: $markdown-spacer-3;
22
+ }
23
+ li + li {
24
+ margin-top: 0.25em;
25
+ }
26
+ dl {
27
+ padding: 0;
28
+ dt {
29
+ margin: 0;
30
+ padding: 0;
31
+ margin-top: $markdown-spacer-3;
32
+ font-size: 1em;
33
+ font-style: italic;
34
+ font-weight: $markdown-font-weight-bold;
35
+ }
36
+ dd {
37
+ margin: 0;
38
+ padding: 0 $markdown-spacer-3;
39
+ margin-bottom: $markdown-spacer-3;
40
+ }
41
+ }
42
+ }
@@ -6,26 +6,21 @@
6
6
  display: block;
7
7
  width: 100%;
8
8
  overflow: auto;
9
-
10
- th {
11
- font-weight: $font-weight-bold;
12
- }
13
-
14
9
  th,
15
10
  td {
16
11
  padding: 6px 13px;
17
12
  border: 1px solid lighten($gray-300, 5%);
18
13
  }
19
-
14
+ th {
15
+ font-weight: $markdown-font-weight-bold;
16
+ }
20
17
  tr {
21
- background-color: $bg-white;
18
+ background-color: #fff;
22
19
  border-top: 1px solid darken($gray-300, 4%);
23
-
24
20
  &:nth-child(2n) {
25
21
  background-color: $gray-100;
26
22
  }
27
23
  }
28
-
29
24
  img {
30
25
  background-color: transparent;
31
26
  }
@@ -1,5 +1,12 @@
1
- .highlight table td { padding: 5px; }
2
- .highlight table pre { margin: 0; }
1
+ .highlight {
2
+ background-color: #f8f8f8;
3
+ table td {
4
+ padding: 5px;
5
+ }
6
+ table pre {
7
+ margin: 0;
8
+ }
9
+ }
3
10
  .highlight .cm {
4
11
  color: #999988;
5
12
  font-style: italic;
@@ -17,7 +24,8 @@
17
24
  font-weight: bold;
18
25
  font-style: italic;
19
26
  }
20
- .highlight .c, .highlight .cd {
27
+ .highlight .c,
28
+ .highlight .cd {
21
29
  color: #999988;
22
30
  font-style: italic;
23
31
  }
@@ -82,7 +90,8 @@
82
90
  color: #445588;
83
91
  font-weight: bold;
84
92
  }
85
- .highlight .k, .highlight .kv {
93
+ .highlight .k,
94
+ .highlight .kv {
86
95
  color: #000000;
87
96
  font-weight: bold;
88
97
  }
@@ -101,7 +110,9 @@
101
110
  .highlight .mo {
102
111
  color: #009999;
103
112
  }
104
- .highlight .m, .highlight .mb, .highlight .mx {
113
+ .highlight .m,
114
+ .highlight .mb,
115
+ .highlight .mx {
105
116
  color: #009999;
106
117
  }
107
118
  .highlight .sb {
@@ -204,6 +215,3 @@
204
215
  .highlight .w {
205
216
  color: #bbbbbb;
206
217
  }
207
- .highlight {
208
- background-color: #f8f8f8;
209
- }
data/readme.md CHANGED
@@ -28,8 +28,8 @@ A Jekyll theme for Github styled documentation
28
28
  ### Development
29
29
 
30
30
  1. Install rvm/ruby `^2.7.3` if not having done so already
31
- 2. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
32
- 3. `$ bundle install` (install theme deps automatically)
31
+ 2.a. `$ gem install jekyll bundler jekyll-github-metadata jekyll-seo-tag ` (not sudo, or....)
32
+ 2.b. `$ bundle install` (install theme deps automatically)
33
33
  4. `$ jekyll serve`
34
34
 
35
35
  ### Publishing Gem
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: github-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
4
+ version: 0.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricky Boyce
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-05 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
@@ -92,48 +92,32 @@ files:
92
92
  - _layouts/home.html
93
93
  - _layouts/page.html
94
94
  - _layouts/post.html
95
- - _sass/github-docs.scss
96
- - _sass/primer-base/base.scss
97
- - _sass/primer-base/index.scss
98
- - _sass/primer-base/normalize.scss
99
- - _sass/primer-base/typography-base.scss
100
- - _sass/primer-layout/columns.scss
101
- - _sass/primer-layout/container.scss
102
- - _sass/primer-layout/grid-offset.scss
103
- - _sass/primer-layout/grid.scss
104
- - _sass/primer-layout/index.scss
105
- - _sass/primer-markdown/blob-csv.scss
106
- - _sass/primer-markdown/code.scss
107
- - _sass/primer-markdown/headings.scss
108
- - _sass/primer-markdown/images.scss
109
- - _sass/primer-markdown/index.scss
110
- - _sass/primer-markdown/lists.scss
111
- - _sass/primer-markdown/markdown-body.scss
112
- - _sass/primer-markdown/tables.scss
113
- - _sass/primer-support/index.scss
114
- - _sass/primer-support/mixins/buttons.scss
115
- - _sass/primer-support/mixins/layout.scss
116
- - _sass/primer-support/mixins/misc.scss
117
- - _sass/primer-support/mixins/typography.scss
118
- - _sass/primer-support/variables/color-system.scss
119
- - _sass/primer-support/variables/colors.scss
120
- - _sass/primer-support/variables/layout.scss
121
- - _sass/primer-support/variables/misc.scss
122
- - _sass/primer-support/variables/typography.scss
123
- - _sass/primer-utilities/animations.scss
124
- - _sass/primer-utilities/borders.scss
125
- - _sass/primer-utilities/box-shadow.scss
126
- - _sass/primer-utilities/colors.scss
127
- - _sass/primer-utilities/details.scss
128
- - _sass/primer-utilities/flexbox.scss
129
- - _sass/primer-utilities/index.scss
130
- - _sass/primer-utilities/layout.scss
131
- - _sass/primer-utilities/margin.scss
132
- - _sass/primer-utilities/padding.scss
133
- - _sass/primer-utilities/typography.scss
134
- - _sass/primer-utilities/visibility-display.scss
135
- - _sass/rouge.scss
95
+ - assets/css/cherry/_base-normalize.scss
96
+ - assets/css/cherry/_buttons.scss
97
+ - assets/css/cherry/_columns.scss
98
+ - assets/css/cherry/_elements.scss
99
+ - assets/css/cherry/_forms-vue-select.scss
100
+ - assets/css/cherry/_forms.scss
101
+ - assets/css/cherry/_functions.scss
102
+ - assets/css/cherry/_index.scss
103
+ - assets/css/cherry/_layout.scss
104
+ - assets/css/cherry/_modal.scss
105
+ - assets/css/cherry/_spacing.scss
106
+ - assets/css/cherry/_tooltips.scss
107
+ - assets/css/cherry/_typography.scss
108
+ - assets/css/cherry/_utilities.scss
109
+ - assets/css/cherry/_variables-computed.scss
110
+ - assets/css/cherry/_variables.scss
136
111
  - assets/css/index.scss
112
+ - assets/css/main.scss
113
+ - assets/css/primer-markdown/blob-csv.scss
114
+ - assets/css/primer-markdown/code.scss
115
+ - assets/css/primer-markdown/headings.scss
116
+ - assets/css/primer-markdown/images.scss
117
+ - assets/css/primer-markdown/index.scss
118
+ - assets/css/primer-markdown/lists.scss
119
+ - assets/css/primer-markdown/tables.scss
120
+ - assets/css/rouge.scss
137
121
  - assets/imgs/back.svg
138
122
  - assets/js/anchor.min.js
139
123
  - assets/js/index.js
@@ -1,84 +0,0 @@
1
- // stylelint-disable selector-max-type
2
- * {
3
- box-sizing: border-box;
4
- }
5
-
6
- input,
7
- select,
8
- textarea,
9
- button {
10
- font-family: inherit;
11
- font-size: inherit;
12
- line-height: inherit;
13
- }
14
-
15
- body {
16
- font-family: $body-font;
17
- font-size: $body-font-size;
18
- line-height: $body-line-height;
19
- color: $text-gray-dark;
20
- background-color: $bg-white;
21
- }
22
-
23
- a {
24
- color: $text-blue;
25
- text-decoration: none;
26
-
27
- &:hover {
28
- text-decoration: underline;
29
- }
30
- }
31
-
32
- b,
33
- strong {
34
- font-weight: $font-weight-bold;
35
- }
36
-
37
- // Horizontal lines
38
- //
39
- // TODO-MDO: Remove `.rule` from everywhere and replace with `<hr>`s
40
- hr,
41
- .rule {
42
- height: 0;
43
- margin: 15px 0;
44
- overflow: hidden;
45
- background: transparent;
46
- border: 0;
47
- border-bottom: 1px solid lighten($gray-300, 5%);
48
- @include clearfix();
49
- }
50
-
51
- //
52
- // Remove most spacing between table cells.
53
- //
54
-
55
- table {
56
- border-spacing: 0;
57
- border-collapse: collapse;
58
- }
59
-
60
- td,
61
- th {
62
- padding: 0;
63
- }
64
-
65
- button {
66
- cursor: pointer;
67
- // Remove border radius added by Chroma macOS
68
- border-radius: 0;
69
- }
70
-
71
- // increase the selector specificity for [hidden]
72
- // so that it always overrides utility classes (.d-block, etc.)
73
- [hidden][hidden] {
74
- display: none !important;
75
- }
76
-
77
- details {
78
- summary { cursor: pointer; }
79
-
80
- &:not([open]) {
81
- // Set details content hidden by default for browsers that don't do this
82
- > *:not(summary) { display: none !important; }
83
- }
84
- }