jekyll-docs-template 0.1.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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: aaac03eb10f7e21aa7b375af188552a1843d0bd13bc0065b723693f5a7d4dda9
4
+ data.tar.gz: 431cdbdd753ce0a487352de7f32ecbb13e3549581cf8069cf49c4c7fce3dbf0c
5
+ SHA512:
6
+ metadata.gz: ea10fdaf92fa0b5dc525c31822d4d95e7d8c9bf2bda7bda753318ae6da75dab9225eb753f9b364cdb82280ce9861f8677a028d8fa10f6bec8474d0d298cb2cd5
7
+ data.tar.gz: 22deda7d5677e22f3abefea4e10f67af4f6236ff7d1b927f31193e2d3eed88aa7883befa33fcf7449cbd46b9eac135efb15aca14de8e10c1851426f80d33b9b7
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Contributorcoin
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,14 @@
1
+ # GitHub Pages Docs Template
2
+ GitHub Pages Jekyll template for Contributorcoin docs
3
+
4
+ ## Previewing the theme locally
5
+ If you'd like to preview the theme locally (for example, in the process of proposing a change):
6
+
7
+ 1. Clone down the theme's repository (`git clone https://github.com/contributorcoin/jekyll-docs-template`)
8
+ 2. `cd` into the theme's directory
9
+ 3. Run `script/bootstrap` to install the necessary dependencies
10
+ 4. Run `bundle exec jekyll serve` to start the preview server
11
+ 5. Visit `localhost:4000` in your browser to preview the theme
12
+
13
+ ## Running tests
14
+ The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.
@@ -0,0 +1,10 @@
1
+ <!-- {% if site.show_gh_edit and site.github %} -->
2
+ <a
3
+ href="{{ site.github.repository_url }}/blob/{{site.github.source.branch}}{% if site.github.source.path != '/' %}{{site.github.source.path}}{% endif %}/{{ page.path }}"
4
+ class="btn btn-black btn-sm gh-edit-btn"
5
+ target="_blank"
6
+ >
7
+ {% octicon mark-github height:16 aria-label:github %}
8
+ <span>Edit page on GitHub</span>
9
+ </a>
10
+ <!-- {% endif %} -->
@@ -0,0 +1,44 @@
1
+ <button class="btn btn-black toggle-next">
2
+ {{ site.data.global-menu.menu_title | default: 'Menu' }}
3
+ </button>
4
+
5
+ <nav>
6
+ <h3>{{ site.data.global-menu.menu_title | default: 'Menu' }}</h3>
7
+ <ul>
8
+ <!-- {{page.url | replace: ".html", ""}} -->
9
+ {% for item in site.data.global-menu.menu_items %}
10
+ <li>
11
+ <div class="menu-item">
12
+ <a href="{{ item.url }}">{{ item.title }}</a>
13
+
14
+ {% if item.submenu %}
15
+ <button class="toggle-next">{% octicon chevron-down height:16 aria-label:github %}</button>
16
+
17
+ <ul>
18
+ {% for subitem in item.submenu %}
19
+ <li>
20
+ <div class="menu-item">
21
+ <a href="{{ subitem.url }}">{{ subitem.title }}</a>
22
+
23
+ {% if subitem.submenu %}
24
+ <button class="toggle-next">{% octicon chevron-down height:16 aria-label:github %}</button>
25
+
26
+ <ul>
27
+ {% for subsubitem in subitem.submenu %}
28
+ <li>
29
+ <a href="{{ subsubitem.url }}">{{ subsubitem.title }}</a>
30
+ </li>
31
+ {% endfor %}
32
+ </ul>
33
+ {% endif %}
34
+
35
+ </div>
36
+ </li>
37
+ {% endfor %}
38
+ </ul>
39
+ {% endif %}
40
+ </div>
41
+ </li>
42
+ {% endfor %}
43
+ </ul>
44
+ </nav>
@@ -0,0 +1,10 @@
1
+ {% if site.google_analytics %}
2
+ <script>
3
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
7
+ ga('create', '{{ site.google_analytics }}', 'auto');
8
+ ga('send', 'pageview');
9
+ </script>
10
+ {% endif %}
@@ -0,0 +1,9 @@
1
+ <!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
2
+
3
+ <!-- Setup Google Analytics -->
4
+ {% include head-custom-google-analytics.html %}
5
+
6
+ <!-- You can set your favicon here -->
7
+ <!-- link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}" -->
8
+
9
+ <!-- end custom head snippets -->
@@ -0,0 +1,10 @@
1
+ {% if hide_toc != true %}
2
+ <button class="btn btn-black toggle-next">
3
+ {{ site.toc_title | default: 'On this page' }}
4
+ </button>
5
+
6
+ <nav>
7
+ <h4>{{ site.toc_title | default: 'On this page' }}</h4>
8
+ {% include toc.html html=content %}
9
+ </nav>
10
+ {% endif %}
@@ -0,0 +1,128 @@
1
+ {% capture tocWorkspace %}
2
+ {% capture newline %}
3
+ {% endcapture %}
4
+ {% assign newline = newline | rstrip %} <!-- Remove the extra spacing but preserve the newline -->
5
+
6
+ {% capture deprecation_warnings %}{% endcapture %}
7
+
8
+ {% if include.baseurl %}
9
+ {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "baseurl" has been deprecated, use "base_url" instead -->{{ newline }}{% endcapture %}
10
+ {% endif %}
11
+
12
+ {% if include.skipNoIDs %}
13
+ {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "skipNoIDs" has been deprecated, use "skip_no_ids" instead -->{{ newline }}{% endcapture %}
14
+ {% endif %}
15
+
16
+ {% capture jekyll_toc %}{% endcapture %}
17
+ {% assign orderedList = include.ordered | default: false %}
18
+ {% assign baseURL = include.base_url | default: include.baseurl | default: '' %}
19
+ {% assign skipNoIDs = include.skip_no_ids | default: include.skipNoIDs | default: false %}
20
+ {% assign minHeader = include.h_min | default: 1 %}
21
+ {% assign maxHeader = include.h_max | default: 6 %}
22
+ {% assign nodes = include.html | strip | split: '<h' %}
23
+
24
+ {% assign firstHeader = true %}
25
+ {% assign currLevel = 0 %}
26
+ {% assign lastLevel = 0 %}
27
+
28
+ {% capture listModifier %}{% if orderedList %}ol{% else %}ul{% endif %}{% endcapture %}
29
+
30
+ {% for node in nodes %}
31
+ {% if node == "" %}
32
+ {% continue %}
33
+ {% endif %}
34
+
35
+ {% assign currLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
36
+
37
+ {% if currLevel < minHeader or currLevel > maxHeader %}
38
+ {% continue %}
39
+ {% endif %}
40
+
41
+ {% assign _workspace = node | split: '</h' %}
42
+
43
+ {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
44
+ {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
45
+ {% assign htmlID = _idWorkspace[0] %}
46
+
47
+ {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
48
+ {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
49
+ {% assign htmlClass = _classWorkspace[0] %}
50
+
51
+ {% if htmlClass contains "no_toc" %}
52
+ {% continue %}
53
+ {% endif %}
54
+
55
+ {% if firstHeader %}
56
+ {% assign minHeader = currLevel %}
57
+ {% endif %}
58
+
59
+ {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
60
+ {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
61
+
62
+ {% if include.item_class and include.item_class != blank %}
63
+ {% capture listItemClass %} class="{{ include.item_class | replace: '%level%', currLevel | split: '.' | join: ' ' }}"{% endcapture %}
64
+ {% endif %}
65
+
66
+ {% if include.submenu_class and include.submenu_class != blank %}
67
+ {% assign subMenuLevel = currLevel | minus: 1 %}
68
+ {% capture subMenuClass %} class="{{ include.submenu_class | replace: '%level%', subMenuLevel | split: '.' | join: ' ' }}"{% endcapture %}
69
+ {% endif %}
70
+
71
+ {% capture anchorBody %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
72
+
73
+ {% if htmlID %}
74
+ {% capture anchorAttributes %} href="{% if baseURL %}{{ baseURL }}{% endif %}#{{ htmlID }}"{% endcapture %}
75
+
76
+ {% if include.anchor_class %}
77
+ {% capture anchorAttributes %}{{ anchorAttributes }} class="{{ include.anchor_class | split: '.' | join: ' ' }}"{% endcapture %}
78
+ {% endif %}
79
+
80
+ {% capture listItem %}<a{{ anchorAttributes }}>{{ anchorBody }}</a>{% endcapture %}
81
+ {% elsif skipNoIDs == true %}
82
+ {% continue %}
83
+ {% else %}
84
+ {% capture listItem %}{{ anchorBody }}{% endcapture %}
85
+ {% endif %}
86
+
87
+ {% if currLevel > lastLevel %}
88
+ {% capture jekyll_toc %}{{ jekyll_toc }}<{{ listModifier }}{{ subMenuClass }}>{% endcapture %}
89
+ {% elsif currLevel < lastLevel %}
90
+ {% assign repeatCount = lastLevel | minus: currLevel %}
91
+
92
+ {% for i in (1..repeatCount) %}
93
+ {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %}
94
+ {% endfor %}
95
+
96
+ {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %}
97
+ {% else %}
98
+ {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %}
99
+ {% endif %}
100
+
101
+ {% capture jekyll_toc %}{{ jekyll_toc }}<li{{ listItemClass }}>{{ listItem }}{% endcapture %}
102
+
103
+ {% assign lastLevel = currLevel %}
104
+ {% assign firstHeader = false %}
105
+ {% endfor %}
106
+
107
+ {% assign repeatCount = minHeader | minus: 1 %}
108
+ {% assign repeatCount = lastLevel | minus: repeatCount %}
109
+ {% for i in (1..repeatCount) %}
110
+ {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %}
111
+ {% endfor %}
112
+
113
+ {% if jekyll_toc != '' %}
114
+ {% assign rootAttributes = '' %}
115
+ {% if include.class and include.class != blank %}
116
+ {% capture rootAttributes %} class="{{ include.class | split: '.' | join: ' ' }}"{% endcapture %}
117
+ {% endif %}
118
+
119
+ {% if include.id and include.id != blank %}
120
+ {% capture rootAttributes %}{{ rootAttributes }} id="{{ include.id }}"{% endcapture %}
121
+ {% endif %}
122
+
123
+ {% if rootAttributes %}
124
+ {% assign nodes = jekyll_toc | split: '>' %}
125
+ {% capture jekyll_toc %}<{{ listModifier }}{{ rootAttributes }}>{{ nodes | shift | join: '>' }}>{% endcapture %}
126
+ {% endif %}
127
+ {% endif %}
128
+ {% endcapture %}{% assign tocWorkspace = '' %}{{ deprecation_warnings }}{{ jekyll_toc -}}
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html>
2
+ <html lang="{{ site.lang | default: "en-US" }}">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+
6
+ {% seo %}
7
+ <link rel="preconnect" href="https://fonts.gstatic.com">
8
+ <link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,700&display=swap" as="style" type="text/css" crossorigin>
9
+ <meta name="viewport" content="width=device-width, initial-scale=1">
10
+ <meta name="theme-color" content="#157878">
11
+ <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
12
+ <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
13
+ {% include head-custom.html %}
14
+ </head>
15
+ <body>
16
+ <a id="skip-to-content" href="#content">Skip to the content.</a>
17
+
18
+ <header class="page-header" role="banner">
19
+ <h1 class="project-name">
20
+ {% if page.url != '/' %}<a href="/">{% endif %}
21
+ {{site.title | default: site.github.repository_name}}
22
+ {% if page.url != '/' %}</a>{% endif %}
23
+ </h1>
24
+ <h2 class="project-tagline">{{ site.description | default: site.github.project_tagline }}</h2>
25
+ {% if site.github.is_project_page %}
26
+ <a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
27
+ {% endif %}
28
+ {% if site.show_downloads %}
29
+ <div class="btn-group">
30
+ <a href="{{ site.github.zip_url }}" class="btn btn-primary-lt">Download .zip</a>
31
+ <a href="{{ site.github.tar_url }}" class="btn btn-primary-lt">Download .tar.gz</a>
32
+ </div>
33
+ {% endif %}
34
+ </header>
35
+
36
+ <main class="main-content" role="main">
37
+ <aside class="main-menu">
38
+ {% include global-menu.html %}
39
+ </aside>
40
+ <aside class="contents-table">
41
+ {% include page-contents.html %}
42
+ </aside>
43
+ <div id="content" class="page-content">
44
+ {{ content }}
45
+ {% include gh-edit-btn.html %}
46
+ </div>
47
+ </main>
48
+
49
+ <footer class="site-footer">
50
+ {% if site.github.is_project_page %}
51
+ <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
52
+ {% endif %}
53
+ <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
54
+ </footer>
55
+
56
+ <script src="{{ '/assets/js/scripts.js?v=' | append: site.github.build_revision | relative_url }}"></script>
57
+ </body>
58
+ </html>
data/_sass/base.scss ADDED
@@ -0,0 +1,38 @@
1
+ body {
2
+ width: 100%;
3
+ }
4
+
5
+ #skip-to-content {
6
+ height: 1px;
7
+ width: 1px;
8
+ position: absolute;
9
+ overflow: hidden;
10
+ top: -10px;
11
+
12
+ &:focus {
13
+ position: fixed;
14
+ top: 10px;
15
+ left: 10px;
16
+ height: auto;
17
+ width: auto;
18
+ background: invert($link--color);
19
+ outline: thick solid invert($link--color);
20
+ }
21
+ }
22
+
23
+ a {
24
+ color: $link--color;
25
+
26
+ &:hover {
27
+ text-decoration: none;
28
+ }
29
+ }
30
+
31
+ img {
32
+ height: auto;
33
+ max-width: 100%;
34
+ }
35
+
36
+ svg {
37
+ fill: currentColor;
38
+ }
data/_sass/footer.scss ADDED
@@ -0,0 +1,10 @@
1
+ .site-footer {
2
+ background-color: $color--primary;
3
+ color: $color--primary-lt;
4
+ padding: calc(1.5 * #{$global--spacing-vertical}) calc(2 * #{$global--spacing-horizontal});
5
+ text-align: center;
6
+
7
+ a {
8
+ color: $color--primary-lt;
9
+ }
10
+ }
data/_sass/header.scss ADDED
@@ -0,0 +1,32 @@
1
+ .page-header {
2
+ background-color: $color--primary;
3
+ color: $color--primary-lt;
4
+ padding: calc(3 * #{$global--spacing-vertical}) calc(2 * #{$global--spacing-horizontal});
5
+ text-align: center;
6
+
7
+ a {
8
+ color: $color--primary-lt;
9
+ }
10
+
11
+ .project-name {
12
+ font-size: 2.5rem;
13
+ margin-bottom: calc(1.15 * #{$global--spacing-vertical});
14
+
15
+ a {
16
+ text-decoration: none;
17
+ }
18
+ }
19
+
20
+ .project-tagline {
21
+ font-weight: 400;
22
+ margin-bottom: calc(1.25 * #{$global--spacing-vertical});
23
+ }
24
+
25
+ > *:first-child {
26
+ margin-top: 0;
27
+ }
28
+
29
+ > *:last-child {
30
+ margin-bottom: 0;
31
+ }
32
+ }
@@ -0,0 +1,8 @@
1
+ @import "variables-mixins";
2
+ @import "normalize";
3
+ @import url('https://fonts.googleapis.com/css?family=Open+Sans:400,600,700&display=swap');
4
+ @import "base";
5
+ @import "header";
6
+ @import "main";
7
+ @import "footer";
8
+ @import "utilities";
data/_sass/main.scss ADDED
@@ -0,0 +1,165 @@
1
+ .main-content {
2
+ display: grid;
3
+ gap: $global--spacing-vertical;
4
+ grid-template-areas:
5
+ "menu"
6
+ "contents"
7
+ "page";
8
+ grid-template-columns: minmax(0, 1fr);
9
+ margin-left: auto;
10
+ margin-right: auto;
11
+ max-width: 1200px;
12
+ padding: calc(2 * #{$global--spacing-vertical}) $global--spacing-horizontal;
13
+
14
+ @include media(desktop) {
15
+ gap: calc(2 * #{$global--spacing-vertical});
16
+ grid-template-areas:
17
+ "menu page"
18
+ "contents page";
19
+ grid-template-columns: 200px minmax(0, 3fr);
20
+ grid-template-rows: min-content 1fr;
21
+ padding: calc(3 * #{$global--spacing-vertical}) calc(2 * #{$global--spacing-horizontal});
22
+ }
23
+
24
+ @include media(wide) {
25
+ grid-template-areas: "menu page contents";
26
+ grid-template-columns: 200px minmax(0, 3fr) 200px;
27
+ }
28
+ }
29
+
30
+ .main-menu {
31
+ grid-area: menu;
32
+
33
+ h3 {
34
+ display: none;
35
+ margin-top: 0;
36
+
37
+ @include media(desktop) {
38
+ display: block;
39
+ }
40
+ }
41
+
42
+ ul {
43
+ list-style: none;
44
+ padding: 0;
45
+
46
+ ul {
47
+ border-left: 1px dotted $color--primary-lt;
48
+ font-size: .95em;
49
+ display: none;
50
+ padding-left: calc(.25 * #{$global--spacing-horizontal});
51
+
52
+ &.show {
53
+ display: block;
54
+ }
55
+ }
56
+ }
57
+
58
+ li {
59
+ margin: calc(.5 * #{$global--spacing-vertical}) 0;
60
+ }
61
+
62
+ .menu-item {
63
+ display: grid;
64
+ column-gap: calc(.5 * #{$global--spacing-horizontal});
65
+ grid-template-columns: 1fr auto;
66
+
67
+ > ul {
68
+ grid-column: 1 / -1;
69
+ }
70
+
71
+ button {
72
+ align-items: center;
73
+ background: none;
74
+ border: none;
75
+ color: $color--primary;
76
+ display: flex;
77
+ font-size: 1rem;
78
+ padding: 1px 2px;
79
+ }
80
+ }
81
+ }
82
+
83
+ .page-content {
84
+ grid-area: page;
85
+
86
+ > *:first-child {
87
+ margin-top: 0;
88
+ }
89
+
90
+ > *:last-child {
91
+ margin-bottom: 0;
92
+ }
93
+ }
94
+
95
+ .contents-table {
96
+ grid-area: contents;
97
+
98
+ h4 {
99
+ display: none;
100
+ margin-top: 0;
101
+
102
+ @include media(desktop) {
103
+ display: block;
104
+ }
105
+ }
106
+
107
+ ul {
108
+ font-size: .9rem;
109
+ list-style: none;
110
+ padding-left: calc(.25 * #{$global--spacing-horizontal});
111
+
112
+ li {
113
+ margin: calc(.5 * #{$global--spacing-vertical}) 0;
114
+ }
115
+
116
+ ul {
117
+ font-size: .95em;
118
+ border-left: 1px dotted $color--primary-lt;
119
+ }
120
+ }
121
+ }
122
+
123
+ .main-menu,
124
+ .contents-table {
125
+ > .toggle-next {
126
+ font-size: .85rem;
127
+ justify-content: center;
128
+ width: 100%;
129
+
130
+ @include media(desktop) {
131
+ display: none;
132
+ }
133
+ }
134
+
135
+ nav {
136
+ display: none;
137
+ max-height: calc(100vh - #{$global--spacing-vertical});
138
+ overflow-y: auto;
139
+ top: $global--spacing-vertical;
140
+
141
+ &.show {
142
+ display: block;
143
+ }
144
+
145
+ @include media(desktop) {
146
+ display: block;
147
+ }
148
+
149
+ @include media(wide) {
150
+ position: sticky;
151
+ }
152
+
153
+ a {
154
+ text-decoration: none;
155
+
156
+ &:hover {
157
+ text-decoration: underline;
158
+ }
159
+ }
160
+ }
161
+ }
162
+
163
+ .gh-edit-btn {
164
+ margin-top: $global--spacing-vertical;
165
+ }
@@ -0,0 +1,424 @@
1
+ /*! normalize.css v3.0.2 | MIT License | git.io/normalize */
2
+
3
+ /**
4
+ * 1. Set default font family to sans-serif.
5
+ * 2. Prevent iOS text size adjust after orientation change, without disabling
6
+ * user zoom.
7
+ */
8
+
9
+ html {
10
+ font-family: sans-serif; /* 1 */
11
+ -ms-text-size-adjust: 100%; /* 2 */
12
+ -webkit-text-size-adjust: 100%; /* 2 */
13
+ }
14
+
15
+ /**
16
+ * Remove default margin.
17
+ */
18
+
19
+ body {
20
+ margin: 0;
21
+ }
22
+
23
+ /* HTML5 display definitions
24
+ ========================================================================== */
25
+
26
+ /**
27
+ * Correct `block` display not defined for any HTML5 element in IE 8/9.
28
+ * Correct `block` display not defined for `details` or `summary` in IE 10/11
29
+ * and Firefox.
30
+ * Correct `block` display not defined for `main` in IE 11.
31
+ */
32
+
33
+ article,
34
+ aside,
35
+ details,
36
+ figcaption,
37
+ figure,
38
+ footer,
39
+ header,
40
+ hgroup,
41
+ main,
42
+ menu,
43
+ nav,
44
+ section,
45
+ summary {
46
+ display: block;
47
+ }
48
+
49
+ /**
50
+ * 1. Correct `inline-block` display not defined in IE 8/9.
51
+ * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
52
+ */
53
+
54
+ audio,
55
+ canvas,
56
+ progress,
57
+ video {
58
+ display: inline-block; /* 1 */
59
+ vertical-align: baseline; /* 2 */
60
+ }
61
+
62
+ /**
63
+ * Prevent modern browsers from displaying `audio` without controls.
64
+ * Remove excess height in iOS 5 devices.
65
+ */
66
+
67
+ audio:not([controls]) {
68
+ display: none;
69
+ height: 0;
70
+ }
71
+
72
+ /**
73
+ * Address `[hidden]` styling not present in IE 8/9/10.
74
+ * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
75
+ */
76
+
77
+ [hidden],
78
+ template {
79
+ display: none;
80
+ }
81
+
82
+ /* Links
83
+ ========================================================================== */
84
+
85
+ /**
86
+ * Remove the gray background color from active links in IE 10.
87
+ */
88
+
89
+ a {
90
+ background-color: transparent;
91
+ }
92
+
93
+ /**
94
+ * Improve readability when focused and also mouse hovered in all browsers.
95
+ */
96
+
97
+ a:active,
98
+ a:hover {
99
+ outline: 0;
100
+ }
101
+
102
+ /* Text-level semantics
103
+ ========================================================================== */
104
+
105
+ /**
106
+ * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
107
+ */
108
+
109
+ abbr[title] {
110
+ border-bottom: 1px dotted;
111
+ }
112
+
113
+ /**
114
+ * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
115
+ */
116
+
117
+ b,
118
+ strong {
119
+ font-weight: bold;
120
+ }
121
+
122
+ /**
123
+ * Address styling not present in Safari and Chrome.
124
+ */
125
+
126
+ dfn {
127
+ font-style: italic;
128
+ }
129
+
130
+ /**
131
+ * Address variable `h1` font-size and margin within `section` and `article`
132
+ * contexts in Firefox 4+, Safari, and Chrome.
133
+ */
134
+
135
+ h1 {
136
+ font-size: 2em;
137
+ margin: 0.67em 0;
138
+ }
139
+
140
+ /**
141
+ * Address styling not present in IE 8/9.
142
+ */
143
+
144
+ mark {
145
+ background: #ff0;
146
+ color: #000;
147
+ }
148
+
149
+ /**
150
+ * Address inconsistent and variable font size in all browsers.
151
+ */
152
+
153
+ small {
154
+ font-size: 80%;
155
+ }
156
+
157
+ /**
158
+ * Prevent `sub` and `sup` affecting `line-height` in all browsers.
159
+ */
160
+
161
+ sub,
162
+ sup {
163
+ font-size: 75%;
164
+ line-height: 0;
165
+ position: relative;
166
+ vertical-align: baseline;
167
+ }
168
+
169
+ sup {
170
+ top: -0.5em;
171
+ }
172
+
173
+ sub {
174
+ bottom: -0.25em;
175
+ }
176
+
177
+ /* Embedded content
178
+ ========================================================================== */
179
+
180
+ /**
181
+ * Remove border when inside `a` element in IE 8/9/10.
182
+ */
183
+
184
+ img {
185
+ border: 0;
186
+ }
187
+
188
+ /**
189
+ * Correct overflow not hidden in IE 9/10/11.
190
+ */
191
+
192
+ svg:not(:root) {
193
+ overflow: hidden;
194
+ }
195
+
196
+ /* Grouping content
197
+ ========================================================================== */
198
+
199
+ /**
200
+ * Address margin not present in IE 8/9 and Safari.
201
+ */
202
+
203
+ figure {
204
+ margin: 1em 40px;
205
+ }
206
+
207
+ /**
208
+ * Address differences between Firefox and other browsers.
209
+ */
210
+
211
+ hr {
212
+ box-sizing: content-box;
213
+ height: 0;
214
+ }
215
+
216
+ /**
217
+ * Contain overflow in all browsers.
218
+ */
219
+
220
+ pre {
221
+ overflow: auto;
222
+ }
223
+
224
+ /**
225
+ * Address odd `em`-unit font size rendering in all browsers.
226
+ */
227
+
228
+ code,
229
+ kbd,
230
+ pre,
231
+ samp {
232
+ font-family: monospace, monospace;
233
+ font-size: 1em;
234
+ }
235
+
236
+ /* Forms
237
+ ========================================================================== */
238
+
239
+ /**
240
+ * Known limitation: by default, Chrome and Safari on OS X allow very limited
241
+ * styling of `select`, unless a `border` property is set.
242
+ */
243
+
244
+ /**
245
+ * 1. Correct color not being inherited.
246
+ * Known issue: affects color of disabled elements.
247
+ * 2. Correct font properties not being inherited.
248
+ * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
249
+ */
250
+
251
+ button,
252
+ input,
253
+ optgroup,
254
+ select,
255
+ textarea {
256
+ color: inherit; /* 1 */
257
+ font: inherit; /* 2 */
258
+ margin: 0; /* 3 */
259
+ }
260
+
261
+ /**
262
+ * Address `overflow` set to `hidden` in IE 8/9/10/11.
263
+ */
264
+
265
+ button {
266
+ overflow: visible;
267
+ }
268
+
269
+ /**
270
+ * Address inconsistent `text-transform` inheritance for `button` and `select`.
271
+ * All other form control elements do not inherit `text-transform` values.
272
+ * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
273
+ * Correct `select` style inheritance in Firefox.
274
+ */
275
+
276
+ button,
277
+ select {
278
+ text-transform: none;
279
+ }
280
+
281
+ /**
282
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
283
+ * and `video` controls.
284
+ * 2. Correct inability to style clickable `input` types in iOS.
285
+ * 3. Improve usability and consistency of cursor style between image-type
286
+ * `input` and others.
287
+ */
288
+
289
+ button,
290
+ html input[type="button"], /* 1 */
291
+ input[type="reset"],
292
+ input[type="submit"] {
293
+ -webkit-appearance: button; /* 2 */
294
+ cursor: pointer; /* 3 */
295
+ }
296
+
297
+ /**
298
+ * Re-set default cursor for disabled elements.
299
+ */
300
+
301
+ button[disabled],
302
+ html input[disabled] {
303
+ cursor: default;
304
+ }
305
+
306
+ /**
307
+ * Remove inner padding and border in Firefox 4+.
308
+ */
309
+
310
+ button::-moz-focus-inner,
311
+ input::-moz-focus-inner {
312
+ border: 0;
313
+ padding: 0;
314
+ }
315
+
316
+ /**
317
+ * Address Firefox 4+ setting `line-height` on `input` using `!important` in
318
+ * the UA stylesheet.
319
+ */
320
+
321
+ input {
322
+ line-height: normal;
323
+ }
324
+
325
+ /**
326
+ * It's recommended that you don't attempt to style these elements.
327
+ * Firefox's implementation doesn't respect box-sizing, padding, or width.
328
+ *
329
+ * 1. Address box sizing set to `content-box` in IE 8/9/10.
330
+ * 2. Remove excess padding in IE 8/9/10.
331
+ */
332
+
333
+ input[type="checkbox"],
334
+ input[type="radio"] {
335
+ box-sizing: border-box; /* 1 */
336
+ padding: 0; /* 2 */
337
+ }
338
+
339
+ /**
340
+ * Fix the cursor style for Chrome's increment/decrement buttons. For certain
341
+ * `font-size` values of the `input`, it causes the cursor style of the
342
+ * decrement button to change from `default` to `text`.
343
+ */
344
+
345
+ input[type="number"]::-webkit-inner-spin-button,
346
+ input[type="number"]::-webkit-outer-spin-button {
347
+ height: auto;
348
+ }
349
+
350
+ /**
351
+ * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
352
+ * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
353
+ * (include `-moz` to future-proof).
354
+ */
355
+
356
+ input[type="search"] {
357
+ -webkit-appearance: textfield; /* 1 */ /* 2 */
358
+ box-sizing: content-box;
359
+ }
360
+
361
+ /**
362
+ * Remove inner padding and search cancel button in Safari and Chrome on OS X.
363
+ * Safari (but not Chrome) clips the cancel button when the search input has
364
+ * padding (and `textfield` appearance).
365
+ */
366
+
367
+ input[type="search"]::-webkit-search-cancel-button,
368
+ input[type="search"]::-webkit-search-decoration {
369
+ -webkit-appearance: none;
370
+ }
371
+
372
+ /**
373
+ * Define consistent border, margin, and padding.
374
+ */
375
+
376
+ fieldset {
377
+ border: 1px solid #c0c0c0;
378
+ margin: 0 2px;
379
+ padding: 0.35em 0.625em 0.75em;
380
+ }
381
+
382
+ /**
383
+ * 1. Correct `color` not being inherited in IE 8/9/10/11.
384
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
385
+ */
386
+
387
+ legend {
388
+ border: 0; /* 1 */
389
+ padding: 0; /* 2 */
390
+ }
391
+
392
+ /**
393
+ * Remove default vertical scrollbar in IE 8/9/10/11.
394
+ */
395
+
396
+ textarea {
397
+ overflow: auto;
398
+ }
399
+
400
+ /**
401
+ * Don't inherit the `font-weight` (applied by a rule above).
402
+ * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
403
+ */
404
+
405
+ optgroup {
406
+ font-weight: bold;
407
+ }
408
+
409
+ /* Tables
410
+ ========================================================================== */
411
+
412
+ /**
413
+ * Remove most spacing between table cells.
414
+ */
415
+
416
+ table {
417
+ border-collapse: collapse;
418
+ border-spacing: 0;
419
+ }
420
+
421
+ td,
422
+ th {
423
+ padding: 0;
424
+ }
@@ -0,0 +1,28 @@
1
+ .btn {
2
+ @include btn;
3
+ }
4
+
5
+ .btn-sm {
6
+ font-size: .75rem;
7
+ padding: calc(.25 * #{$global--spacing-vertical}) calc(.5 * #{$global--spacing-horizontal});
8
+ }
9
+
10
+ .btn-primary {
11
+ @include btn-primary;
12
+ }
13
+
14
+ .btn-primary-lt {
15
+ @include btn-primary-lt;
16
+ }
17
+
18
+ .btn-black {
19
+ @include btn-black;
20
+ }
21
+
22
+ .btn-group {
23
+ align-items: center;
24
+ display: flex;
25
+ flex-wrap: wrap;
26
+ gap: calc(.75 * #{$global--spacing-horizontal});
27
+ justify-content: center;
28
+ }
@@ -0,0 +1,84 @@
1
+ $color--primary: #160f29;
2
+ $color--primary-lt: #cdabd1;
3
+
4
+ $link--color: rgba($color--primary, .75);
5
+
6
+ $global--spacing-horizontal: 2rem;
7
+ $global--spacing-vertical: 1.5rem;
8
+
9
+
10
+ $breakpoint_sm: 482px;
11
+ $breakpoint_md: 592px;
12
+ $breakpoint_lg: 652px;
13
+ $breakpoint_xl: 822px;
14
+ $breakpoint_xxl: 1024px;
15
+
16
+ // Responsive breakpoints mixin
17
+ @mixin media( $res ) {
18
+
19
+ @if mobile == $res {
20
+ @media only screen and (min-width: #{$breakpoint_sm}) {
21
+ @content;
22
+ }
23
+ }
24
+
25
+ @if tablet == $res {
26
+ @media only screen and (min-width: #{$breakpoint_md}) {
27
+ @content;
28
+ }
29
+ }
30
+
31
+ @if laptop == $res {
32
+ @media only screen and (min-width: #{$breakpoint_lg}) {
33
+ @content;
34
+ }
35
+ }
36
+
37
+ @if desktop == $res {
38
+ @media only screen and (min-width: #{$breakpoint_xl}) {
39
+ @content;
40
+ }
41
+ }
42
+
43
+ @if wide == $res {
44
+ @media only screen and (min-width: #{$breakpoint_xxl}) {
45
+ @content;
46
+ }
47
+ }
48
+ }
49
+
50
+ @mixin btn {
51
+ align-items: center;
52
+ border: 1px solid currentColor;
53
+ border-radius: 4px;
54
+ display: inline-flex;
55
+ font-weight: 600;
56
+ gap: calc(.25 * #{$global--spacing-vertical});
57
+ padding: calc(.5 * #{$global--spacing-vertical}) calc(.75 * #{$global--spacing-horizontal});
58
+ text-decoration: none;
59
+ transition: background-color ease 300ms;
60
+ }
61
+
62
+ @mixin btn-primary {
63
+ background-color: rgba($color--primary, .1);
64
+
65
+ &:hover {
66
+ background-color: rgba($color--primary, .15);
67
+ }
68
+ }
69
+
70
+ @mixin btn-primary-lt {
71
+ background-color: rgba($color--primary-lt, .1);
72
+
73
+ &:hover {
74
+ background-color: rgba($color--primary-lt, .15);
75
+ }
76
+ }
77
+
78
+ @mixin btn-black {
79
+ background-color: rgba(black, .1);
80
+
81
+ &:hover {
82
+ background-color: rgba(black, .15);
83
+ }
84
+ }
@@ -0,0 +1,4 @@
1
+ ---
2
+ ---
3
+
4
+ @import 'jekyll-docs-template';
@@ -0,0 +1,6 @@
1
+ document.querySelectorAll('.toggle-next').forEach((button) => {
2
+ button.addEventListener('click', () => {
3
+ button.classList.toggle('active');
4
+ button.nextElementSibling.classList.toggle('show');
5
+ });
6
+ });
metadata ADDED
@@ -0,0 +1,139 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jekyll-docs-template
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Morgan Spencer
8
+ - Contributorcoin
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2021-11-10 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: jekyll
16
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - ">"
19
+ - !ruby/object:Gem::Version
20
+ version: '3.5'
21
+ - - "<"
22
+ - !ruby/object:Gem::Version
23
+ version: '5.0'
24
+ type: :runtime
25
+ prerelease: false
26
+ version_requirements: !ruby/object:Gem::Requirement
27
+ requirements:
28
+ - - ">"
29
+ - !ruby/object:Gem::Version
30
+ version: '3.5'
31
+ - - "<"
32
+ - !ruby/object:Gem::Version
33
+ version: '5.0'
34
+ - !ruby/object:Gem::Dependency
35
+ name: jekyll-seo-tag
36
+ requirement: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.0'
41
+ type: :runtime
42
+ prerelease: false
43
+ version_requirements: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '2.0'
48
+ - !ruby/object:Gem::Dependency
49
+ name: html-proofer
50
+ requirement: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ - !ruby/object:Gem::Dependency
63
+ name: rubocop-github
64
+ requirement: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.16'
69
+ type: :development
70
+ prerelease: false
71
+ version_requirements: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.16'
76
+ - !ruby/object:Gem::Dependency
77
+ name: w3c_validators
78
+ requirement: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.3'
83
+ type: :development
84
+ prerelease: false
85
+ version_requirements: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '1.3'
90
+ description:
91
+ email:
92
+ - hello@contributorcoin.com
93
+ executables: []
94
+ extensions: []
95
+ extra_rdoc_files: []
96
+ files:
97
+ - LICENSE
98
+ - README.md
99
+ - _includes/gh-edit-btn.html
100
+ - _includes/global-menu.html
101
+ - _includes/head-custom-google-analytics.html
102
+ - _includes/head-custom.html
103
+ - _includes/page-contents.html
104
+ - _includes/toc.html
105
+ - _layouts/default.html
106
+ - _sass/base.scss
107
+ - _sass/footer.scss
108
+ - _sass/header.scss
109
+ - _sass/jekyll-docs-template.scss
110
+ - _sass/main.scss
111
+ - _sass/normalize.scss
112
+ - _sass/utilities.scss
113
+ - _sass/variables-mixins.scss
114
+ - assets/css/style.scss
115
+ - assets/js/scripts.js
116
+ homepage: https://github.com/contributorcoin/jekyll-docs-template
117
+ licenses:
118
+ - MIT
119
+ metadata: {}
120
+ post_install_message:
121
+ rdoc_options: []
122
+ require_paths:
123
+ - lib
124
+ required_ruby_version: !ruby/object:Gem::Requirement
125
+ requirements:
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: 2.4.0
129
+ required_rubygems_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ requirements: []
135
+ rubygems_version: 3.2.31
136
+ signing_key:
137
+ specification_version: 4
138
+ summary: GitHub Pages Jekyll template for Contributorcoin docs
139
+ test_files: []