github-docs 0.0.1
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/_includes/sidebar.html +66 -0
- data/_layouts/default.html +50 -0
- data/_layouts/home.html +4 -0
- data/_layouts/page.html +4 -0
- data/_layouts/post.html +4 -0
- data/_sass/github-docs.scss +215 -0
- data/_sass/primer-base/base.scss +84 -0
- data/_sass/primer-base/index.scss +3 -0
- data/_sass/primer-base/normalize.scss +421 -0
- data/_sass/primer-base/typography-base.scss +86 -0
- data/_sass/primer-layout/columns.scss +54 -0
- data/_sass/primer-layout/container.scss +30 -0
- data/_sass/primer-layout/grid-offset.scss +19 -0
- data/_sass/primer-layout/grid.scss +64 -0
- data/_sass/primer-layout/index.scss +4 -0
- data/_sass/primer-markdown/blob-csv.scss +27 -0
- data/_sass/primer-markdown/code.scss +63 -0
- data/_sass/primer-markdown/headings.scss +65 -0
- data/_sass/primer-markdown/images.scss +119 -0
- data/_sass/primer-markdown/index.scss +7 -0
- data/_sass/primer-markdown/lists.scss +76 -0
- data/_sass/primer-markdown/markdown-body.scss +106 -0
- data/_sass/primer-markdown/tables.scss +33 -0
- data/_sass/primer-support/index.scss +11 -0
- data/_sass/primer-support/mixins/buttons.scss +160 -0
- data/_sass/primer-support/mixins/layout.scss +58 -0
- data/_sass/primer-support/mixins/misc.scss +29 -0
- data/_sass/primer-support/mixins/typography.scss +84 -0
- data/_sass/primer-support/variables/color-system.scss +114 -0
- data/_sass/primer-support/variables/colors.scss +67 -0
- data/_sass/primer-support/variables/layout.scss +78 -0
- data/_sass/primer-support/variables/misc.scss +40 -0
- data/_sass/primer-support/variables/typography.scss +43 -0
- data/_sass/primer-utilities/animations.scss +184 -0
- data/_sass/primer-utilities/borders.scss +100 -0
- data/_sass/primer-utilities/box-shadow.scss +26 -0
- data/_sass/primer-utilities/colors.scss +106 -0
- data/_sass/primer-utilities/details.scss +18 -0
- data/_sass/primer-utilities/flexbox.scss +52 -0
- data/_sass/primer-utilities/index.scss +13 -0
- data/_sass/primer-utilities/layout.scss +85 -0
- data/_sass/primer-utilities/margin.scss +53 -0
- data/_sass/primer-utilities/padding.scss +54 -0
- data/_sass/primer-utilities/typography.scss +215 -0
- data/_sass/primer-utilities/visibility-display.scss +87 -0
- data/_sass/rouge.scss +209 -0
- data/assets/css/index.scss +16 -0
- data/assets/imgs/back.svg +1 -0
- data/assets/js/anchor.min.js +6 -0
- data/assets/js/index.js +52 -0
- data/readme.md +34 -0
- metadata +156 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6d6188095aaa675382e73ebd8c56185a41dc32770a3327fc3c86cb1593da5d07
|
4
|
+
data.tar.gz: 74aade5111ea19698953d006f5f5885ff07c492dda4f687deee5a3add4b5b982
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 368b8a581cd05c5c29640915a47166d9d12ff4809a914abc8e9955c8b2c614631866e2f57dc846da620493d9830f00107d725a41ed18daa0b291088a0f5b60d0
|
7
|
+
data.tar.gz: 0acc32f2d1bd70b4aeec808f0af5a4ea791a2aec10e84bbe946463cba7ffbf20f6863b04da8fc1f839c78fa1098875903fc03be630e07ffbf71cfb33193f4d05
|
@@ -0,0 +1,66 @@
|
|
1
|
+
<div class="sidebar-overlay toggle-nav"></div>
|
2
|
+
|
3
|
+
<div class="sidebar-heading">
|
4
|
+
<a href="{{ "/" | absolute_url }}">
|
5
|
+
{% if site.logo %}<div class="sidebar-logo"></div>
|
6
|
+
{% else %}{{ site.title }}{% endif %}
|
7
|
+
</a>
|
8
|
+
<button class="toggle-nav mobile-only">Menu</button>
|
9
|
+
</div>
|
10
|
+
|
11
|
+
<nav class="sidebar-nav" role="navigation">
|
12
|
+
<div class="sidebar-heading-mobile mobile-only">
|
13
|
+
<div class="sidebar-close toggle-nav">
|
14
|
+
<img src="{{ "/assets/imgs/back.svg?v=1" | relative_url }}" />
|
15
|
+
</div>
|
16
|
+
</div>
|
17
|
+
<ul class="navigation-list">
|
18
|
+
{%- assign pages_list = site.html_pages | sort:"nav_order" -%}
|
19
|
+
{%- for node in pages_list -%}
|
20
|
+
{%- unless node.nav_exclude -%}
|
21
|
+
{%- if node.parent == nil -%}
|
22
|
+
<li class="navigation-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
|
23
|
+
{%- if page.parent == node.title or page.grand_parent == node.title -%}
|
24
|
+
{%- assign first_level_url = node.url | absolute_url -%}
|
25
|
+
{%- endif -%}
|
26
|
+
<a href="{{ node.url | absolute_url }}" class="navigation-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
|
27
|
+
{%- if node.has_children -%}
|
28
|
+
{%- assign children_list = site.html_pages | where: "parent", node.title | sort:"nav_order" -%}
|
29
|
+
<ul class="navigation-list-child-list ">
|
30
|
+
{%- for child in children_list -%}
|
31
|
+
<li class="navigation-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
|
32
|
+
{%- if page.url == child.url or page.parent == child.title -%}
|
33
|
+
{%- assign second_level_url = child.url | absolute_url -%}
|
34
|
+
{%- endif -%}
|
35
|
+
<a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
|
36
|
+
{%- if child.has_children -%}
|
37
|
+
{%- assign grand_children_list = site.html_pages | where: "parent", child.title | sort:"nav_order" -%}
|
38
|
+
<ul class="navigation-list-child-list">
|
39
|
+
{%- for grand_child in grand_children_list -%}
|
40
|
+
<li class="navigation-list-item {% if page.url == grand_child.url %} active{% endif %}">
|
41
|
+
<a href="{{ grand_child.url | absolute_url }}" class="navigation-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
|
42
|
+
</li>
|
43
|
+
{%- endfor -%}
|
44
|
+
</ul>
|
45
|
+
{%- endif -%}
|
46
|
+
</li>
|
47
|
+
{%- endfor -%}
|
48
|
+
</ul>
|
49
|
+
{%- endif -%}
|
50
|
+
</li>
|
51
|
+
{%- endif -%}
|
52
|
+
{%- endunless -%}
|
53
|
+
{%- endfor -%}
|
54
|
+
</ul>
|
55
|
+
{% if site.aux_links != nil %}
|
56
|
+
<ul class="navigation-list navigation-list-aux">
|
57
|
+
{% for link in site.aux_links %}
|
58
|
+
<li class="navigation-list-item">
|
59
|
+
<a class="navigation-list-link" href="{{ link.last }}">
|
60
|
+
{{ link.first }}
|
61
|
+
</a>
|
62
|
+
</li>
|
63
|
+
{% endfor %}
|
64
|
+
</ul>
|
65
|
+
{% endif %}
|
66
|
+
</nav>
|
@@ -0,0 +1,50 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="{{ site.lang | default: "en-US" }}">
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
6
|
+
<link rel="stylesheet" href="{{ "/assets/css/index.css?v=1" | relative_url }}">
|
7
|
+
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;900&display=swap" rel="stylesheet">
|
8
|
+
{% seo %}
|
9
|
+
</head>
|
10
|
+
<body>
|
11
|
+
<div class="docs">
|
12
|
+
<div class="sidebar">
|
13
|
+
{% include sidebar.html %}
|
14
|
+
</div>
|
15
|
+
<div class="content">
|
16
|
+
<div class="content-body p-6 markdown-body">
|
17
|
+
{{ content }}
|
18
|
+
{% if page.has_children == true and page.has_toc != false %}
|
19
|
+
<hr>
|
20
|
+
<h2 class="text-delta">Table of contents</h2>
|
21
|
+
{% assign children_list = site.pages | sort:"nav_order" %}
|
22
|
+
<ul>
|
23
|
+
{% for child in children_list %}
|
24
|
+
{% if child.parent == page.title and child.title != page.title %}
|
25
|
+
<li>
|
26
|
+
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>
|
27
|
+
{% if child.summary %} - {{ child.summary }}{% endif %}
|
28
|
+
</li>
|
29
|
+
{% endif %}
|
30
|
+
{% endfor %}
|
31
|
+
</ul>
|
32
|
+
{% endif %}
|
33
|
+
</div>
|
34
|
+
</div>
|
35
|
+
</div>
|
36
|
+
<script src="{{ "/assets/js/anchor.min.js?1" | relative_url }}"></script>
|
37
|
+
<script src="{{ "/assets/js/index.js?1" | relative_url }}"></script>
|
38
|
+
<script>anchors.add();</script>
|
39
|
+
{% if site.google_analytics %}
|
40
|
+
<script>
|
41
|
+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
42
|
+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
43
|
+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
44
|
+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
45
|
+
ga('create', '{{ site.google_analytics }}', 'auto');
|
46
|
+
ga('send', 'pageview')
|
47
|
+
;</script>
|
48
|
+
{% endif %}
|
49
|
+
</body>
|
50
|
+
</html>
|
data/_layouts/home.html
ADDED
data/_layouts/page.html
ADDED
data/_layouts/post.html
ADDED
@@ -0,0 +1,215 @@
|
|
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
|
+
}
|
24
|
+
@media (max-width: 800px) {
|
25
|
+
.content {
|
26
|
+
margin-left: 0;
|
27
|
+
}
|
28
|
+
}
|
29
|
+
|
30
|
+
/* --- Sidebar ----------------------- */
|
31
|
+
|
32
|
+
.sidebar {
|
33
|
+
position: fixed;
|
34
|
+
top: 0;
|
35
|
+
width: $sidebar-width;
|
36
|
+
height: 100vh;
|
37
|
+
background: $sidebar-bg;
|
38
|
+
border-right: 1px solid darken($sidebar-bg, 3%);
|
39
|
+
z-index: 2;
|
40
|
+
}
|
41
|
+
.sidebar:after {
|
42
|
+
content: "";
|
43
|
+
position: absolute;
|
44
|
+
top: 0;
|
45
|
+
left: -10000px;
|
46
|
+
right: 100%;
|
47
|
+
bottom: 0;
|
48
|
+
background: $sidebar-bg;
|
49
|
+
}
|
50
|
+
.sidebar-heading {
|
51
|
+
height: $sidebar-heading-height;
|
52
|
+
display: flex;
|
53
|
+
align-items: center;
|
54
|
+
justify-content: space-between;
|
55
|
+
border-bottom: 1px solid #eee;
|
56
|
+
font-family: 'Roboto', sans-serif;
|
57
|
+
font-size: 1.5em;
|
58
|
+
font-weight: 900;
|
59
|
+
letter-spacing: -0.5px;
|
60
|
+
}
|
61
|
+
.sidebar-heading a {
|
62
|
+
color: #232035;
|
63
|
+
text-decoration: none;
|
64
|
+
}
|
65
|
+
.sidebar-heading button {
|
66
|
+
flex: 0;
|
67
|
+
padding: 9px 25px;
|
68
|
+
font-size: 14px;
|
69
|
+
font-weight: 600;
|
70
|
+
color: #fff;
|
71
|
+
background-color: #483973;
|
72
|
+
border-radius: 3px;
|
73
|
+
border: 0;
|
74
|
+
box-shadow: 0 4px 6px rgba(50,50,93,0.11), 0 1px 3px rgba(0,0,0,0.08);
|
75
|
+
transition: box-shadow 0.2s ease;
|
76
|
+
}
|
77
|
+
.sidebar-heading button:hover {
|
78
|
+
box-shadow: 0 4px 6px rgba(50,50,93,0.3), 0 1px 3px rgba(0,0,0,0.3);
|
79
|
+
}
|
80
|
+
.sidebar-close,
|
81
|
+
.sidebar-heading,
|
82
|
+
.navigation-list-link {
|
83
|
+
padding-left: 30px;
|
84
|
+
padding-right: 30px;
|
85
|
+
}
|
86
|
+
.sidebar-nav {
|
87
|
+
position: relative;
|
88
|
+
z-index: 11;
|
89
|
+
padding: 0px 1px;
|
90
|
+
}
|
91
|
+
|
92
|
+
/* sidebar heading mobile */
|
93
|
+
|
94
|
+
.sidebar-heading-mobile {
|
95
|
+
border-bottom: 1px solid #eee;
|
96
|
+
}
|
97
|
+
.sidebar-close {
|
98
|
+
display: flex;
|
99
|
+
align-items: center;
|
100
|
+
height: $sidebar-heading-height - 10px;
|
101
|
+
cursor: pointer;
|
102
|
+
padding: 0 25px;
|
103
|
+
}
|
104
|
+
.sidebar-close img {
|
105
|
+
width: 22px;
|
106
|
+
margin-left: -2px;
|
107
|
+
}
|
108
|
+
.sidebar-close:hover {
|
109
|
+
|
110
|
+
}
|
111
|
+
@media (max-width: 800px) {
|
112
|
+
.sidebar {
|
113
|
+
position: static;
|
114
|
+
top: auto;
|
115
|
+
width: 100%;
|
116
|
+
height: auto;
|
117
|
+
background: none;
|
118
|
+
}
|
119
|
+
.sidebar-nav {
|
120
|
+
position: fixed;
|
121
|
+
left: -$sidebar-width;
|
122
|
+
top: 0;
|
123
|
+
width: $sidebar-width;
|
124
|
+
height: 100vh;
|
125
|
+
background: $sidebar-bg;
|
126
|
+
border-right: 1px solid darken($sidebar-bg, 3%);
|
127
|
+
box-shadow: rgba(0, 0, 0, 0.14) 0px 0px 4px, rgba(0, 0, 0, 0.28) 0px 4px 8px;
|
128
|
+
transition: transform 400ms cubic-bezier(0.4, 0, 0, 1);
|
129
|
+
transform: translate(0, 0);
|
130
|
+
}
|
131
|
+
.sidebar-heading,
|
132
|
+
.sidebar-close,
|
133
|
+
.navigation-list-link {
|
134
|
+
padding-left: 40px;
|
135
|
+
padding-right: 40px;
|
136
|
+
}
|
137
|
+
.sidebar-overlay {
|
138
|
+
position: fixed;
|
139
|
+
top: 0;
|
140
|
+
left: 0;
|
141
|
+
right: 100%;
|
142
|
+
bottom: 0;
|
143
|
+
z-index: 0;
|
144
|
+
opacity: 0;
|
145
|
+
background-color: rgba(24, 48, 85, 0.3);
|
146
|
+
transition: opacity 250ms ease-in-out, right 0s 250ms;
|
147
|
+
}
|
148
|
+
.nav-open .sidebar-nav {
|
149
|
+
transform: translate($sidebar-width, 0);
|
150
|
+
}
|
151
|
+
.nav-open .sidebar-overlay {
|
152
|
+
transition: opacity 250ms ease-in-out;
|
153
|
+
right: 0;
|
154
|
+
opacity: 1;
|
155
|
+
}
|
156
|
+
}
|
157
|
+
@media (min-width: 801px) {
|
158
|
+
.mobile-only {
|
159
|
+
display: none;
|
160
|
+
}
|
161
|
+
.sidebar-overlay {
|
162
|
+
display: none;
|
163
|
+
}
|
164
|
+
}
|
165
|
+
|
166
|
+
/* --- Navigation -------------------- */
|
167
|
+
|
168
|
+
.navigation-list {
|
169
|
+
padding: 20px 0;
|
170
|
+
display: block;
|
171
|
+
list-style: none;
|
172
|
+
}
|
173
|
+
.navigation-list-link {
|
174
|
+
position: relative;
|
175
|
+
display: block;
|
176
|
+
padding-top: 5px;
|
177
|
+
padding-bottom: 5px;
|
178
|
+
color: $menu-color;
|
179
|
+
font-size: 1.1em;
|
180
|
+
}
|
181
|
+
.navigation-list-link.active,
|
182
|
+
.navigation-list-link:hover {
|
183
|
+
text-decoration: none;
|
184
|
+
color: darken($menu-color, 40%);
|
185
|
+
}
|
186
|
+
.navigation-list-link:before {
|
187
|
+
content: "";
|
188
|
+
position: absolute;
|
189
|
+
display: block;
|
190
|
+
top: 50%;
|
191
|
+
left: 0;
|
192
|
+
height: 18px;
|
193
|
+
width: 4px;
|
194
|
+
margin-top: -9px;
|
195
|
+
background-color: transparent;
|
196
|
+
border-radius: 3px;
|
197
|
+
transform: translateX(-3px);
|
198
|
+
transition: all 0.2s ease;
|
199
|
+
}
|
200
|
+
.navigation-list-link.active:before,
|
201
|
+
.navigation-list-link:hover:before {
|
202
|
+
background-color: $menu-color;
|
203
|
+
transform: translateX(0);
|
204
|
+
}
|
205
|
+
|
206
|
+
/* aux navigation */
|
207
|
+
|
208
|
+
.navigation-list-aux {
|
209
|
+
padding: 0 0 20px;
|
210
|
+
display: block;
|
211
|
+
list-style: none;
|
212
|
+
}
|
213
|
+
.navigation-list-aux .navigation-list-link:before {
|
214
|
+
display: none;
|
215
|
+
}
|
@@ -0,0 +1,84 @@
|
|
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
|
+
}
|