opengitdocs 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/README.md +31 -0
- data/_includes/footer.html +5 -0
- data/_includes/head.html +15 -0
- data/_includes/menu.html +16 -0
- data/_includes/meta.html +41 -0
- data/_includes/nav.html +9 -0
- data/_includes/sidebar.html +21 -0
- data/_layouts/default.html +24 -0
- data/_layouts/index.html +16 -0
- data/_layouts/page.html +30 -0
- data/_layouts/post.html +39 -0
- data/_sass/_base.scss +158 -0
- data/_sass/_dark-colors.scss +12 -0
- data/_sass/_grid.scss +64 -0
- data/_sass/_light-colors.scss +12 -0
- data/_sass/_markdown.scss +103 -0
- data/_sass/_monokai.scss +70 -0
- data/_sass/_nav.scss +92 -0
- data/_sass/_reset.scss +48 -0
- data/_sass/_sidebar.scss +39 -0
- data/_sass/_variables.scss +25 -0
- data/_sass/style-definitions.scss +7 -0
- data/assets/css/style.scss +11 -0
- data/assets/img/book-open-dark.svg +1 -0
- data/assets/img/book-open.svg +1 -0
- metadata +111 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: fc5559e64ddd819f82dfaa292e1ded149a79f31ed66353703a8da7c8130600bb
|
4
|
+
data.tar.gz: 4d7e60279e979f09f40646241382cf15a5402cd3364dc4db3a3fdc66ab7cb2d8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: aca5aa92c7e5218a7fe1a9c2eed2695ee945bb72209324812e61b1a93896e8896a70f61a47e6bebf2408aba34bc6c2e32f32ebf444b2e0ce3b9b42d619ad1db5
|
7
|
+
data.tar.gz: 98923ce47a4a720838799c1141aa557235daa7adebbfb69aaa56171bd04474cc38d236a6cdbb1c91cba29edd8715bfda57fdf06b86ca7df69616f4a5c2a9d598
|
data/README.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# OpenGitDocs for Jekyll 🧪
|
2
|
+
|
3
|
+
A straightforward documentation site theme for static sites built with Jekyll.
|
4
|
+
|
5
|
+
To preview the theme and read the docs, see the site that this repository builds at [opengitdocs.com/jekyll](https://opengitdocs.com/jekyll).
|
6
|
+
|
7
|
+
## Features
|
8
|
+
|
9
|
+
- A smart, automatically generated sidebar menu
|
10
|
+
- Content ordered by your sections, with nested pages
|
11
|
+
- A `config` option to hide nested pages and show only top level pages
|
12
|
+
- Built-in light and dark themes you can switch with a `config` option
|
13
|
+
- Your choice of custom sidebar color and syntax highlighting theme
|
14
|
+
|
15
|
+
![Theme screenshot](/screenshot.png)
|
16
|
+
|
17
|
+
## Installation
|
18
|
+
|
19
|
+
This theme can be installed as a Gemfile, as a remote theme using GitHub Pages, or by manually copying the theme files. See [full instructions here](https://opengitdocs.com/jekyll/guide/install.html).
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Layouts include:
|
24
|
+
|
25
|
+
- An `index`, or home page.
|
26
|
+
- `page` to show a list of available documents: [see example](httsp:/opengitdocs.com/jekyll/guide/index.html).
|
27
|
+
- `post` to show a single document: [see example](https://opengitdocs.com/jekyll/guide/test-and-build.html).
|
28
|
+
|
29
|
+
## Configuration
|
30
|
+
|
31
|
+
See a [sample configuration file and instructions here](https://opengitdocs.com/jekyll/guide/configure.html). OpenGitDocs sets reasonable defaults for missing non-required parameters. Any parameters you set in your site's configuration will override the theme defaults.
|
data/_includes/head.html
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
<head>
|
2
|
+
<meta charset="utf-8">
|
3
|
+
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
4
|
+
<meta name="HandheldFriendly" content="True">
|
5
|
+
<meta name="MobileOptimized" content="320">
|
6
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
7
|
+
{% include meta.html %}
|
8
|
+
<title>
|
9
|
+
{{ page.title | escape }}{% if page.title != site.title %} | {{ site.title }}{% endif %}
|
10
|
+
</title>
|
11
|
+
{% if site.ico %}
|
12
|
+
<link rel="shortcut icon" href="{{ site.ico | relative_url }}">
|
13
|
+
{% endif %}
|
14
|
+
<link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}" media="screen">
|
15
|
+
</head>
|
data/_includes/menu.html
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
{% if site.nav %}
|
2
|
+
<ul>{% include nav.html nav=site.nav%}</ul>
|
3
|
+
{% else %}
|
4
|
+
<ul>
|
5
|
+
{% for page in site.pages %}
|
6
|
+
{% if page.title %}
|
7
|
+
<li><a href="{{ page.url | absolute_url }}">{{ page.title }}</a></li>
|
8
|
+
{% endif %}
|
9
|
+
{% endfor %}
|
10
|
+
{% for page in site.documents %}
|
11
|
+
{% if page.title %}
|
12
|
+
<li><a href="{{ page.url | absolute_url }}">{{ page.title }}</a></li>
|
13
|
+
{% endif %}
|
14
|
+
{% endfor %}
|
15
|
+
</ul>
|
16
|
+
{% endif %}
|
data/_includes/meta.html
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
<link rel="canonical" href="{{ page.url | absolute_url }}" />
|
2
|
+
<meta name="generator" content="Jekyll v{{ jekyll.version }}" />
|
3
|
+
<meta property="og:locale" content="{{ site.language | replace:'-','_' }}" />
|
4
|
+
<meta property="og:url" content="{{ page.url | absolute_url }}" />
|
5
|
+
<meta property="og:site_name" content="{{ site.title }}" />
|
6
|
+
|
7
|
+
<meta property="og:title" content="
|
8
|
+
{{ page.title | escape }}
|
9
|
+
{% if page.title != site.title %} |
|
10
|
+
{{ site.title }}
|
11
|
+
{% endif %}" />
|
12
|
+
<meta property="twitter:title" content="
|
13
|
+
{{ page.title | escape }}
|
14
|
+
{% if page.title != site.title %} |
|
15
|
+
{{ site.title }}
|
16
|
+
{% endif %}" />
|
17
|
+
|
18
|
+
{% if site.description %}
|
19
|
+
<meta name="description" content="{{ site.description }}" />
|
20
|
+
<meta property="og:description" content="{{ site.description }}" />
|
21
|
+
{% endif %}
|
22
|
+
|
23
|
+
{% if page.date %}
|
24
|
+
<meta property="og:type" content="article" />
|
25
|
+
<meta property="article:published_time" content="{{ page.date | date_to_xmlschema }}" />
|
26
|
+
{% endif %}
|
27
|
+
|
28
|
+
{% if page.image %}
|
29
|
+
<meta name="twitter:card" content="{{ page.twitter.card | default: site.twitter.card | default: "summary_large_image" }}" />
|
30
|
+
<meta property="twitter:image" content="{{ page.image.path }}" />
|
31
|
+
<meta property="og:image" content="{{ page.image.path }}" />
|
32
|
+
{% elsif site.image %}
|
33
|
+
<meta property="twitter:image" content="{{ site.image.path }}" />
|
34
|
+
<meta property="og:image" content="{{ site.image.path }}" />
|
35
|
+
{% else %}
|
36
|
+
<meta name="twitter:card" content="summary" />
|
37
|
+
{% endif %}
|
38
|
+
|
39
|
+
{% if site.author.name %}
|
40
|
+
<meta name="author" content="{{ site.author.name }}" />
|
41
|
+
{% endif %}
|
data/_includes/nav.html
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
{% for item in include.nav %}
|
2
|
+
<li><a href="{{ item.url | relative_url }}" {% if item.url == page.url %}class="active"{% endif %}>{{ item.title }}</a></li>
|
3
|
+
|
4
|
+
{% if item.subnav and site.sideBarExpanded %}
|
5
|
+
<ul class="sub-menu">
|
6
|
+
{% include nav.html nav=item.subnav %}
|
7
|
+
</ul>
|
8
|
+
{% endif %}
|
9
|
+
{% endfor %}
|
@@ -0,0 +1,21 @@
|
|
1
|
+
<!-- logo banner-->
|
2
|
+
<div class="banner">
|
3
|
+
<img class="logo-img" src="{% if site.logo %}{{ site.logo | relative_url }}{% else %}{{ "/assets/img/book-open.svg" | relative_url }}{% endif %}">
|
4
|
+
<!-- Jekyll doesn't offer a home page variable, so hack together the URL below -->
|
5
|
+
<a href="{{ site.url }}{{ site.baseurl }}/">
|
6
|
+
<h1>{{ site.title }}</h1>
|
7
|
+
</a>
|
8
|
+
</div>
|
9
|
+
|
10
|
+
<!-- menu begins-->
|
11
|
+
<nav>
|
12
|
+
<div id="menu-toggle">
|
13
|
+
<span id="menu-label">
|
14
|
+
<input type="checkbox" value="Menu" label="Menu" />
|
15
|
+
{%- include menu.html -%}
|
16
|
+
</span>
|
17
|
+
</div>
|
18
|
+
{%- include menu.html -%}
|
19
|
+
</nav>
|
20
|
+
<!-- menu ends -->
|
21
|
+
<hr>
|
@@ -0,0 +1,24 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="{{ page.language | default: site.language | default: "en" }}">
|
3
|
+
|
4
|
+
{%- include head.html -%}
|
5
|
+
|
6
|
+
<body>
|
7
|
+
<div class="wrapper">
|
8
|
+
<aside>
|
9
|
+
{%- include sidebar.html -%}
|
10
|
+
</aside>
|
11
|
+
|
12
|
+
<main>
|
13
|
+
<div class="page-content" aria-label="Content">
|
14
|
+
{{ content }}
|
15
|
+
</div>
|
16
|
+
{%- include footer.html -%}
|
17
|
+
</main>
|
18
|
+
</div>
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
</body>
|
23
|
+
|
24
|
+
</html>
|
data/_layouts/index.html
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
layout: default
|
3
|
+
---
|
4
|
+
|
5
|
+
<header class="homepage-header">
|
6
|
+
<h1 id="title">{{ page.title }}</h1>
|
7
|
+
{% if page.subtitle %}
|
8
|
+
<h2 class="subtitle">{{ page.subtitle }}</h2>
|
9
|
+
{% endif %}
|
10
|
+
</header>
|
11
|
+
|
12
|
+
<section id="main" aria-role="main">
|
13
|
+
<article id="content">
|
14
|
+
{{ content }}
|
15
|
+
</article>
|
16
|
+
</section>
|
data/_layouts/page.html
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
---
|
2
|
+
layout: default
|
3
|
+
---
|
4
|
+
|
5
|
+
<section id="main" aria-role="main">
|
6
|
+
<h1 id="title">{{ page.title }}</h1>
|
7
|
+
<article id="content">
|
8
|
+
{{ content }}
|
9
|
+
</article>
|
10
|
+
</section>
|
11
|
+
|
12
|
+
<div id="grid">
|
13
|
+
<ul id="list-grid">
|
14
|
+
{% assign col = site.collections | where: "label", page.collection %}
|
15
|
+
{% for all in col %}
|
16
|
+
{% for a in all.docs %}
|
17
|
+
{% if a.title != page.title %}
|
18
|
+
<li id="content">
|
19
|
+
<a href="{{ a.url | relative_url }}">
|
20
|
+
<h2>{{ a.title }}</h2>
|
21
|
+
</a>
|
22
|
+
<p>{% if a.excerpt %}{{ a.excerpt }}{% else %}{{ a.content | strip_html | truncatewords: 50, "..." | markdownify }}{% endif %}</p>
|
23
|
+
{% if a.date %}
|
24
|
+
<p id="date">Last updated: {{ a.date | date: "%a, %b %d, %Y" }}</p>{% endif %}
|
25
|
+
</li>
|
26
|
+
{% endif %}
|
27
|
+
{% endfor %%}
|
28
|
+
{% endfor %%}
|
29
|
+
</ul>
|
30
|
+
</div>
|
data/_layouts/post.html
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
---
|
2
|
+
layout: default
|
3
|
+
---
|
4
|
+
|
5
|
+
<section id="main" aria-role="main">
|
6
|
+
<h1 id="title">{{ page.title }}</h1>
|
7
|
+
<article id="content">
|
8
|
+
{{ content }}
|
9
|
+
</article>
|
10
|
+
</section>
|
11
|
+
<section id="paging">
|
12
|
+
<div>
|
13
|
+
{% if page.previous %}
|
14
|
+
<a class="previous" href="{{ page.previous.url | relative_url }}">⟵ Previous: {{page.previous.title}}</a>
|
15
|
+
{% endif %}
|
16
|
+
</div>
|
17
|
+
<div>
|
18
|
+
{% if page.next %}
|
19
|
+
<a class="next" href="{{ page.next.url | relative_url }}">Next: {{page.next.title}} ⟶</a>
|
20
|
+
{% endif %}
|
21
|
+
</div>
|
22
|
+
</section>
|
23
|
+
|
24
|
+
<section id="section-list">
|
25
|
+
{% if page.next or page.previous %}<p>Jump to...</p>{% endif %}
|
26
|
+
{% assign col = site.collections | where: "label", page.collection %}
|
27
|
+
{% for all in col %}
|
28
|
+
{% for a in all.docs %}
|
29
|
+
{% if a.title != page.title %}
|
30
|
+
<p><a class="next" href="{{ a.url | relative_url }}">{{ a.title }}</a></p>
|
31
|
+
{% endif %}
|
32
|
+
{% endfor %%}
|
33
|
+
{% endfor %%}
|
34
|
+
</section>
|
35
|
+
|
36
|
+
<section id="meta">
|
37
|
+
{% if page.date %}
|
38
|
+
<p id="date">Last updated: {{ page.date | date: "%a, %b %d, %Y" }}</p>{% endif %}
|
39
|
+
</section>
|
data/_sass/_base.scss
ADDED
@@ -0,0 +1,158 @@
|
|
1
|
+
* {
|
2
|
+
margin: 0;
|
3
|
+
padding: 0;
|
4
|
+
box-sizing: border-box
|
5
|
+
}
|
6
|
+
|
7
|
+
html {
|
8
|
+
min-height: 100%;
|
9
|
+
min-width: 100%;
|
10
|
+
}
|
11
|
+
|
12
|
+
h1,
|
13
|
+
h2,
|
14
|
+
h3 {
|
15
|
+
font-weight: 500;
|
16
|
+
line-height: 1.6;
|
17
|
+
}
|
18
|
+
|
19
|
+
h1 {
|
20
|
+
font-size: 2em;
|
21
|
+
}
|
22
|
+
|
23
|
+
h2 {
|
24
|
+
font-size: 1.6em;
|
25
|
+
}
|
26
|
+
|
27
|
+
h3 {
|
28
|
+
font-size: 1.5em;
|
29
|
+
}
|
30
|
+
|
31
|
+
a,
|
32
|
+
a:visited {
|
33
|
+
color: $link-color;
|
34
|
+
}
|
35
|
+
|
36
|
+
a:hover {
|
37
|
+
color: $text-color;
|
38
|
+
text-decoration: none
|
39
|
+
}
|
40
|
+
|
41
|
+
a:active {
|
42
|
+
color: $accent-background
|
43
|
+
}
|
44
|
+
|
45
|
+
.active {
|
46
|
+
font-weight: 800;
|
47
|
+
|
48
|
+
a {
|
49
|
+
color: $text-color;
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
body {
|
54
|
+
background-color: $background-color;
|
55
|
+
color: $text-color;
|
56
|
+
font-size: $font-size;
|
57
|
+
font-family: $font-family;
|
58
|
+
line-height: $line-height;
|
59
|
+
text-rendering: optimizeLegibility;
|
60
|
+
display: flex;
|
61
|
+
flex-direction: column;
|
62
|
+
min-height: 100vh;
|
63
|
+
min-width: 100%;
|
64
|
+
|
65
|
+
@media screen and (min-width: $large-phone) {
|
66
|
+
flex-direction: row;
|
67
|
+
}
|
68
|
+
|
69
|
+
}
|
70
|
+
|
71
|
+
button {
|
72
|
+
padding: 20px;
|
73
|
+
border: none;
|
74
|
+
border-radius: 5px;
|
75
|
+
background: $accent-background
|
76
|
+
}
|
77
|
+
|
78
|
+
button:hover {
|
79
|
+
box-shadow: 5px 5px $text-color
|
80
|
+
}
|
81
|
+
|
82
|
+
code {
|
83
|
+
background-color: $code-background-color;
|
84
|
+
}
|
85
|
+
|
86
|
+
header {
|
87
|
+
padding: 0 0 1rem 0;
|
88
|
+
|
89
|
+
h1,
|
90
|
+
h2 {
|
91
|
+
margin: 0 0 0.6em 0;
|
92
|
+
}
|
93
|
+
}
|
94
|
+
|
95
|
+
section {
|
96
|
+
display: flex;
|
97
|
+
flex-direction: column;
|
98
|
+
justify-content: space-around;
|
99
|
+
align-items: flex-start;
|
100
|
+
}
|
101
|
+
|
102
|
+
main {
|
103
|
+
padding: calc(#{$banner-height}/3) $padding;
|
104
|
+
width: 100%;
|
105
|
+
max-width: 62rem;
|
106
|
+
|
107
|
+
@media screen and (min-width: $large-phone) {
|
108
|
+
padding: $banner-height calc(#{$banner-height}/2);
|
109
|
+
margin: 0 auto;
|
110
|
+
}
|
111
|
+
}
|
112
|
+
|
113
|
+
#title {
|
114
|
+
font-size: 2.4rem;
|
115
|
+
font-weight: 500;
|
116
|
+
line-height: 1.2;
|
117
|
+
}
|
118
|
+
|
119
|
+
#date {
|
120
|
+
font-size: 0.9rem;
|
121
|
+
}
|
122
|
+
|
123
|
+
#paging {
|
124
|
+
width: 100%;
|
125
|
+
display: flex;
|
126
|
+
flex-direction: row;
|
127
|
+
justify-content: space-between;
|
128
|
+
align-items: center;
|
129
|
+
background-color: transparent;
|
130
|
+
position: relative;
|
131
|
+
|
132
|
+
div {
|
133
|
+
display: flex;
|
134
|
+
justify-content: flex-start;
|
135
|
+
align-items: start;
|
136
|
+
}
|
137
|
+
|
138
|
+
div:nth-child(even) {
|
139
|
+
justify-content: flex-end;
|
140
|
+
}
|
141
|
+
}
|
142
|
+
|
143
|
+
#section-list {
|
144
|
+
margin: 1em 0;
|
145
|
+
align-items: flex-end;
|
146
|
+
justify-content: flex-start;
|
147
|
+
text-align: right;
|
148
|
+
}
|
149
|
+
|
150
|
+
footer, #meta {
|
151
|
+
font-size: 0.9rem;
|
152
|
+
width: 100%;
|
153
|
+
margin: 2rem 0;
|
154
|
+
display: flex;
|
155
|
+
flex-direction: column;
|
156
|
+
justify-content: center;
|
157
|
+
align-items: center;
|
158
|
+
}
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/* Colors */
|
2
|
+
$text-color: #efefef;
|
3
|
+
$accent-color: #c5e0d8;
|
4
|
+
$background-color: #222828;
|
5
|
+
$banner-title: #fff;
|
6
|
+
$border-color: #111;
|
7
|
+
$drop-shadow-color: $border-color;
|
8
|
+
$link-color: $accent-color;
|
9
|
+
$nav-background-color: #293030;
|
10
|
+
$nav-text-color: $text-color;
|
11
|
+
$tile-background-color: #293030;
|
12
|
+
$code-background-color: #444;
|
data/_sass/_grid.scss
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
aside {
|
2
|
+
grid-area: side;
|
3
|
+
}
|
4
|
+
|
5
|
+
main {
|
6
|
+
grid-area: main;
|
7
|
+
}
|
8
|
+
|
9
|
+
.wrapper {
|
10
|
+
min-height: 100%;
|
11
|
+
width: 100%;
|
12
|
+
|
13
|
+
// Main grid is only activated on large screens
|
14
|
+
@media screen and (min-width: $large-phone) {
|
15
|
+
display: grid;
|
16
|
+
grid-template-columns: repeat(9, 1fr);
|
17
|
+
grid-auto-rows: minmax(100px, auto);
|
18
|
+
grid-template-areas: "side side side main main main main main main";
|
19
|
+
}
|
20
|
+
|
21
|
+
@media screen and (min-width: $ipad) {
|
22
|
+
grid-template-areas: "side side side main main main main main main";
|
23
|
+
}
|
24
|
+
|
25
|
+
@media screen and (min-width: $desktop) {
|
26
|
+
grid-template-areas: "side side main main main main main main main";
|
27
|
+
}
|
28
|
+
|
29
|
+
@media screen and (min-width: $widescreen) {
|
30
|
+
grid-template-areas: "side main main main main main main main main";
|
31
|
+
}
|
32
|
+
}
|
33
|
+
|
34
|
+
// For items on list pages
|
35
|
+
#grid {
|
36
|
+
@media screen and (min-width: $large-phone) {
|
37
|
+
margin: 2rem 0 4rem 0;
|
38
|
+
}
|
39
|
+
|
40
|
+
margin: 1.5rem 0;
|
41
|
+
}
|
42
|
+
|
43
|
+
#list-grid {
|
44
|
+
display: grid;
|
45
|
+
grid-gap: 1rem;
|
46
|
+
grid-template-columns: repeat(auto-fit, minmax(350px, 1fr));
|
47
|
+
grid-template-rows: auto;
|
48
|
+
|
49
|
+
li {
|
50
|
+
background-color: $tile-background-color;
|
51
|
+
border: 1px solid $border-color;
|
52
|
+
border-radius: $border-radius;
|
53
|
+
list-style-type: none;
|
54
|
+
padding: 1rem;
|
55
|
+
-webkit-box-shadow: $drop-shadow;
|
56
|
+
-moz-box-shadow: $drop-shadow;
|
57
|
+
box-shadow: $drop-shadow;
|
58
|
+
word-wrap: break-word;
|
59
|
+
|
60
|
+
a {
|
61
|
+
text-decoration: none;
|
62
|
+
}
|
63
|
+
}
|
64
|
+
}
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/* Colors */
|
2
|
+
$text-color: dimgrey;
|
3
|
+
$accent-color: #216685;
|
4
|
+
$background-color: #fefefe;
|
5
|
+
$banner-title: #fff;
|
6
|
+
$border-color: rgb(219, 219, 219);
|
7
|
+
$drop-shadow-color: $border-color;
|
8
|
+
$link-color: $accent-color;
|
9
|
+
$nav-background-color: #fefefe;
|
10
|
+
$nav-text-color: $text-color;
|
11
|
+
$tile-background-color: $background-color;
|
12
|
+
$code-background-color: #e6e6ee;
|
@@ -0,0 +1,103 @@
|
|
1
|
+
#content {
|
2
|
+
max-width: 100%;
|
3
|
+
|
4
|
+
div {
|
5
|
+
width: 100%;
|
6
|
+
height: 100%;
|
7
|
+
}
|
8
|
+
|
9
|
+
p {
|
10
|
+
margin: 1em 0;
|
11
|
+
opacity: 0.8
|
12
|
+
}
|
13
|
+
|
14
|
+
.highlight {
|
15
|
+
width: 100%
|
16
|
+
}
|
17
|
+
|
18
|
+
pre {
|
19
|
+
border-radius: 3px;
|
20
|
+
padding: $padding;
|
21
|
+
overflow-x: auto;
|
22
|
+
background-color: #000004;
|
23
|
+
width: 100%;
|
24
|
+
margin-bottom: 1em
|
25
|
+
}
|
26
|
+
|
27
|
+
pre>code {
|
28
|
+
border: none;
|
29
|
+
background-color: transparent;
|
30
|
+
padding: 0;
|
31
|
+
}
|
32
|
+
|
33
|
+
code {
|
34
|
+
font-family: 'Source Code Pro', monospace;
|
35
|
+
font-size: 0.9em;
|
36
|
+
padding: 1px 3px;
|
37
|
+
border-radius: 3px;
|
38
|
+
border: 1px solid $code-background-color
|
39
|
+
}
|
40
|
+
|
41
|
+
img {
|
42
|
+
max-width: 100%;
|
43
|
+
display: block;
|
44
|
+
margin: 2rem auto;
|
45
|
+
opacity: 1
|
46
|
+
}
|
47
|
+
|
48
|
+
blockquote {
|
49
|
+
background-color: $code-background-color;
|
50
|
+
color: #39424E;
|
51
|
+
padding: 2rem;
|
52
|
+
margin: 2rem 1rem 2rem 1rem;
|
53
|
+
border-radius: 3px
|
54
|
+
}
|
55
|
+
|
56
|
+
blockquote a {
|
57
|
+
color: #111
|
58
|
+
}
|
59
|
+
|
60
|
+
blockquote ul {
|
61
|
+
margin-top: 1rem
|
62
|
+
}
|
63
|
+
|
64
|
+
blockquote li {
|
65
|
+
list-style: disc
|
66
|
+
}
|
67
|
+
|
68
|
+
table {
|
69
|
+
width: 100%;
|
70
|
+
border-collapse: collapse;
|
71
|
+
margin: 1rem 0;
|
72
|
+
overflow-x: auto
|
73
|
+
}
|
74
|
+
|
75
|
+
table td,
|
76
|
+
table th {
|
77
|
+
padding: 2px 5px;
|
78
|
+
border: 1px solid $code-background-color
|
79
|
+
}
|
80
|
+
|
81
|
+
ul {
|
82
|
+
list-style: disc outside;
|
83
|
+
|
84
|
+
@media screen and (min-width: $large-phone) {
|
85
|
+
margin: 2rem
|
86
|
+
}
|
87
|
+
}
|
88
|
+
|
89
|
+
ol {
|
90
|
+
list-style: decimal outside;
|
91
|
+
margin: 2rem
|
92
|
+
}
|
93
|
+
|
94
|
+
.gist {
|
95
|
+
width: 100%
|
96
|
+
}
|
97
|
+
|
98
|
+
.gist td,
|
99
|
+
.gist th {
|
100
|
+
text-align: left;
|
101
|
+
border: 0
|
102
|
+
}
|
103
|
+
}
|
data/_sass/_monokai.scss
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
.highlight .hll { background-color: #49483e }
|
2
|
+
.highlight { background: #272822; color: #f8f8f2 }
|
3
|
+
.highlight .c { color: #75715e } /* Comment */
|
4
|
+
.highlight .err { color: #960050; background-color: #1e0010 } /* Error */
|
5
|
+
.highlight .k { color: #66d9ef } /* Keyword */
|
6
|
+
.highlight .l { color: #ae81ff } /* Literal */
|
7
|
+
.highlight .n { color: #f8f8f2 } /* Name */
|
8
|
+
.highlight .o { color: #f92672 } /* Operator */
|
9
|
+
.highlight .p { color: #f8f8f2 } /* Punctuation */
|
10
|
+
.highlight .ch { color: #75715e } /* Comment.Hashbang */
|
11
|
+
.highlight .cm { color: #75715e } /* Comment.Multiline */
|
12
|
+
.highlight .cp { color: #75715e } /* Comment.Preproc */
|
13
|
+
.highlight .cpf { color: #75715e } /* Comment.PreprocFile */
|
14
|
+
.highlight .c1 { color: #75715e } /* Comment.Single */
|
15
|
+
.highlight .cs { color: #75715e } /* Comment.Special */
|
16
|
+
.highlight .gd { color: #f92672 } /* Generic.Deleted */
|
17
|
+
.highlight .ge { font-style: italic } /* Generic.Emph */
|
18
|
+
.highlight .gi { color: #a6e22e } /* Generic.Inserted */
|
19
|
+
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
20
|
+
.highlight .gu { color: #75715e } /* Generic.Subheading */
|
21
|
+
.highlight .kc { color: #66d9ef } /* Keyword.Constant */
|
22
|
+
.highlight .kd { color: #66d9ef } /* Keyword.Declaration */
|
23
|
+
.highlight .kn { color: #f92672 } /* Keyword.Namespace */
|
24
|
+
.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */
|
25
|
+
.highlight .kr { color: #66d9ef } /* Keyword.Reserved */
|
26
|
+
.highlight .kt { color: #66d9ef } /* Keyword.Type */
|
27
|
+
.highlight .ld { color: #e6db74 } /* Literal.Date */
|
28
|
+
.highlight .m { color: #ae81ff } /* Literal.Number */
|
29
|
+
.highlight .s { color: #e6db74 } /* Literal.String */
|
30
|
+
.highlight .na { color: #a6e22e } /* Name.Attribute */
|
31
|
+
.highlight .nb { color: #f8f8f2 } /* Name.Builtin */
|
32
|
+
.highlight .nc { color: #a6e22e } /* Name.Class */
|
33
|
+
.highlight .no { color: #66d9ef } /* Name.Constant */
|
34
|
+
.highlight .nd { color: #a6e22e } /* Name.Decorator */
|
35
|
+
.highlight .ni { color: #f8f8f2 } /* Name.Entity */
|
36
|
+
.highlight .ne { color: #a6e22e } /* Name.Exception */
|
37
|
+
.highlight .nf { color: #a6e22e } /* Name.Function */
|
38
|
+
.highlight .nl { color: #f8f8f2 } /* Name.Label */
|
39
|
+
.highlight .nn { color: #f8f8f2 } /* Name.Namespace */
|
40
|
+
.highlight .nx { color: #a6e22e } /* Name.Other */
|
41
|
+
.highlight .py { color: #f8f8f2 } /* Name.Property */
|
42
|
+
.highlight .nt { color: #f92672 } /* Name.Tag */
|
43
|
+
.highlight .nv { color: #f8f8f2 } /* Name.Variable */
|
44
|
+
.highlight .ow { color: #f92672 } /* Operator.Word */
|
45
|
+
.highlight .w { color: #f8f8f2 } /* Text.Whitespace */
|
46
|
+
.highlight .mb { color: #ae81ff } /* Literal.Number.Bin */
|
47
|
+
.highlight .mf { color: #ae81ff } /* Literal.Number.Float */
|
48
|
+
.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */
|
49
|
+
.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */
|
50
|
+
.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */
|
51
|
+
.highlight .sa { color: #e6db74 } /* Literal.String.Affix */
|
52
|
+
.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */
|
53
|
+
.highlight .sc { color: #e6db74 } /* Literal.String.Char */
|
54
|
+
.highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */
|
55
|
+
.highlight .sd { color: #e6db74 } /* Literal.String.Doc */
|
56
|
+
.highlight .s2 { color: #e6db74 } /* Literal.String.Double */
|
57
|
+
.highlight .se { color: #ae81ff } /* Literal.String.Escape */
|
58
|
+
.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */
|
59
|
+
.highlight .si { color: #e6db74 } /* Literal.String.Interpol */
|
60
|
+
.highlight .sx { color: #e6db74 } /* Literal.String.Other */
|
61
|
+
.highlight .sr { color: #e6db74 } /* Literal.String.Regex */
|
62
|
+
.highlight .s1 { color: #e6db74 } /* Literal.String.Single */
|
63
|
+
.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */
|
64
|
+
.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */
|
65
|
+
.highlight .fm { color: #a6e22e } /* Name.Function.Magic */
|
66
|
+
.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */
|
67
|
+
.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */
|
68
|
+
.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */
|
69
|
+
.highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */
|
70
|
+
.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */
|
data/_sass/_nav.scss
ADDED
@@ -0,0 +1,92 @@
|
|
1
|
+
nav {
|
2
|
+
background: $nav-background-color;
|
3
|
+
color: $nav-text-color;
|
4
|
+
margin: 0;
|
5
|
+
padding: $padding;
|
6
|
+
|
7
|
+
a {
|
8
|
+
text-decoration: none;
|
9
|
+
}
|
10
|
+
|
11
|
+
#menu-toggle {
|
12
|
+
position: relative;
|
13
|
+
|
14
|
+
@media screen and (min-width: $large-phone) {
|
15
|
+
display: none;
|
16
|
+
}
|
17
|
+
|
18
|
+
display: block;
|
19
|
+
user-select: none;
|
20
|
+
|
21
|
+
input {
|
22
|
+
cursor: pointer;
|
23
|
+
background: transparent;
|
24
|
+
display: block;
|
25
|
+
opacity: 0;
|
26
|
+
height: 100%;
|
27
|
+
min-height: $line-height;
|
28
|
+
width: 100%;
|
29
|
+
border: none;
|
30
|
+
-webkit-touch-callout: none;
|
31
|
+
z-index: 20;
|
32
|
+
}
|
33
|
+
|
34
|
+
input~ul {
|
35
|
+
display: none;
|
36
|
+
}
|
37
|
+
|
38
|
+
input:checked~ul {
|
39
|
+
display: block;
|
40
|
+
|
41
|
+
}
|
42
|
+
}
|
43
|
+
|
44
|
+
#menu-label::before {
|
45
|
+
content: "Menu";
|
46
|
+
font-weight: 800;
|
47
|
+
position: absolute;
|
48
|
+
top: 0;
|
49
|
+
}
|
50
|
+
|
51
|
+
ul {
|
52
|
+
display: none;
|
53
|
+
list-style: none;
|
54
|
+
padding: 0;
|
55
|
+
margin: 0;
|
56
|
+
|
57
|
+
}
|
58
|
+
|
59
|
+
@media screen and (min-width: $large-phone) {
|
60
|
+
ul {
|
61
|
+
display: block;
|
62
|
+
border-bottom: 1px solid $border-color;
|
63
|
+
}
|
64
|
+
|
65
|
+
ul:last-child {
|
66
|
+
border-bottom: none;
|
67
|
+
}
|
68
|
+
}
|
69
|
+
|
70
|
+
li {
|
71
|
+
padding: 0.5em;
|
72
|
+
border-bottom: 1px solid $border-color;
|
73
|
+
}
|
74
|
+
|
75
|
+
li:last-child {
|
76
|
+
border-bottom: none;
|
77
|
+
}
|
78
|
+
}
|
79
|
+
|
80
|
+
.sub-menu {
|
81
|
+
padding: 0;
|
82
|
+
margin: 0 0 0 1em;
|
83
|
+
}
|
84
|
+
|
85
|
+
.crumbs {
|
86
|
+
font-size: 0.9rem;
|
87
|
+
margin-bottom: 1.5rem;
|
88
|
+
|
89
|
+
a {
|
90
|
+
text-decoration: none;
|
91
|
+
}
|
92
|
+
}
|
data/_sass/_reset.scss
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
/* http://meyerweb.com/eric/tools/css/reset/
|
2
|
+
v2.0 | 20110126
|
3
|
+
License: none (public domain)
|
4
|
+
*/
|
5
|
+
|
6
|
+
html, body, div, span, applet, object, iframe,
|
7
|
+
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
|
8
|
+
a, abbr, acronym, address, big, cite, code,
|
9
|
+
del, dfn, em, img, ins, kbd, q, s, samp,
|
10
|
+
small, strike, strong, sub, sup, tt, var,
|
11
|
+
b, u, i, center,
|
12
|
+
dl, dt, dd, ol, ul, li,
|
13
|
+
fieldset, form, label, legend,
|
14
|
+
table, caption, tbody, tfoot, thead, tr, th, td,
|
15
|
+
article, aside, canvas, details, embed,
|
16
|
+
figure, figcaption, footer, header, hgroup,
|
17
|
+
menu, nav, output, ruby, section, summary,
|
18
|
+
time, mark, audio, video {
|
19
|
+
margin: 0;
|
20
|
+
padding: 0;
|
21
|
+
border: 0;
|
22
|
+
font-size: 100%;
|
23
|
+
font: inherit;
|
24
|
+
vertical-align: baseline;
|
25
|
+
}
|
26
|
+
/* HTML5 display-role reset for older browsers */
|
27
|
+
article, aside, details, figcaption, figure,
|
28
|
+
footer, header, hgroup, menu, nav, section {
|
29
|
+
display: block;
|
30
|
+
}
|
31
|
+
body {
|
32
|
+
line-height: 1;
|
33
|
+
}
|
34
|
+
ol, ul {
|
35
|
+
list-style: none;
|
36
|
+
}
|
37
|
+
blockquote, q {
|
38
|
+
quotes: none;
|
39
|
+
}
|
40
|
+
blockquote:before, blockquote:after,
|
41
|
+
q:before, q:after {
|
42
|
+
content: '';
|
43
|
+
content: none;
|
44
|
+
}
|
45
|
+
table {
|
46
|
+
border-collapse: collapse;
|
47
|
+
border-spacing: 0;
|
48
|
+
}
|
data/_sass/_sidebar.scss
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
aside {
|
2
|
+
background-color: $sidebar-background;
|
3
|
+
|
4
|
+
@media screen and (min-width: $large-phone) {
|
5
|
+
position: sticky;
|
6
|
+
top: 0;
|
7
|
+
z-index: 100;
|
8
|
+
box-shadow: $drop-shadow;
|
9
|
+
}
|
10
|
+
|
11
|
+
hr {
|
12
|
+
background-color: $accent-color;
|
13
|
+
border: none;
|
14
|
+
height: 3px;
|
15
|
+
margin: 0;
|
16
|
+
padding: 0;
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
.banner {
|
21
|
+
display: flex;
|
22
|
+
min-height: $banner-height;
|
23
|
+
justify-content: start;
|
24
|
+
align-items: center;
|
25
|
+
|
26
|
+
a,
|
27
|
+
h1 {
|
28
|
+
color: $banner-title;
|
29
|
+
font-size: $banner-title-size;
|
30
|
+
font-weight: $banner-title-weight;
|
31
|
+
text-decoration: none;
|
32
|
+
}
|
33
|
+
|
34
|
+
.logo-img {
|
35
|
+
width: 100%;
|
36
|
+
max-width: $logo-size;
|
37
|
+
padding: $padding;
|
38
|
+
}
|
39
|
+
}
|
@@ -0,0 +1,25 @@
|
|
1
|
+
/* Breakpoints */
|
2
|
+
$small-phone: 640px;
|
3
|
+
$large-phone: 812px;
|
4
|
+
$ipad: 1024px;
|
5
|
+
$desktop: 1240px;
|
6
|
+
$widescreen: 2500px;
|
7
|
+
|
8
|
+
/* General Spacing */
|
9
|
+
$padding: 10px;
|
10
|
+
$line-height: 1.6rem;
|
11
|
+
$banner-height: 6rem;
|
12
|
+
|
13
|
+
/* Styling */
|
14
|
+
$accent-background: linear-gradient(-242deg, $accent-color, $border-color);
|
15
|
+
$border-radius: $padding;
|
16
|
+
$logo-size: $banner-height;
|
17
|
+
$drop-shadow: 6px 22px 42px -7px $drop-shadow-color;
|
18
|
+
|
19
|
+
/* Font Styling */
|
20
|
+
$banner-title-size: 1.85rem;
|
21
|
+
$banner-title-weight: 500;
|
22
|
+
$font-size: 18px;
|
23
|
+
$font-family: Arial,
|
24
|
+
x-locale-body,
|
25
|
+
sans-serif;
|
@@ -0,0 +1,11 @@
|
|
1
|
+
---
|
2
|
+
---
|
3
|
+
|
4
|
+
{% assign theme = site.colorTheme %}
|
5
|
+
{% assign mainColor = site.mainColor %}
|
6
|
+
@charset 'utf-8';
|
7
|
+
|
8
|
+
$sidebar-background: #{{ mainColor | default: "016087" }};
|
9
|
+
|
10
|
+
@import '_{{ theme | default: light }}-colors';
|
11
|
+
@import "style-definitions";
|
@@ -0,0 +1 @@
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="black" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather feather-book-open"><path d="M2 3h6a4 4 0 0 1 4 4v14a3 3 0 0 0-3-3H2z"></path><path d="M22 3h-6a4 4 0 0 0-4 4v14a3 3 0 0 1 3-3h7z"></path></svg>
|
@@ -0,0 +1 @@
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="white" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather feather-book-open"><path d="M2 3h6a4 4 0 0 1 4 4v14a3 3 0 0 0-3-3H2z"></path><path d="M22 3h-6a4 4 0 0 0-4 4v14a3 3 0 0 1 3-3h7z"></path></svg>
|
metadata
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: opengitdocs
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Victoria Drake
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-03-04 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: jekyll
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '4.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '4.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description:
|
56
|
+
email:
|
57
|
+
- hello@victoria.dev
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- README.md
|
63
|
+
- _includes/footer.html
|
64
|
+
- _includes/head.html
|
65
|
+
- _includes/menu.html
|
66
|
+
- _includes/meta.html
|
67
|
+
- _includes/nav.html
|
68
|
+
- _includes/sidebar.html
|
69
|
+
- _layouts/default.html
|
70
|
+
- _layouts/index.html
|
71
|
+
- _layouts/page.html
|
72
|
+
- _layouts/post.html
|
73
|
+
- _sass/_base.scss
|
74
|
+
- _sass/_dark-colors.scss
|
75
|
+
- _sass/_grid.scss
|
76
|
+
- _sass/_light-colors.scss
|
77
|
+
- _sass/_markdown.scss
|
78
|
+
- _sass/_monokai.scss
|
79
|
+
- _sass/_nav.scss
|
80
|
+
- _sass/_reset.scss
|
81
|
+
- _sass/_sidebar.scss
|
82
|
+
- _sass/_variables.scss
|
83
|
+
- _sass/style-definitions.scss
|
84
|
+
- assets/css/style.scss
|
85
|
+
- assets/img/book-open-dark.svg
|
86
|
+
- assets/img/book-open.svg
|
87
|
+
homepage: https://opengitdocs.com/jekyll
|
88
|
+
licenses:
|
89
|
+
- Apache-2.0
|
90
|
+
metadata: {}
|
91
|
+
post_install_message:
|
92
|
+
rdoc_options: []
|
93
|
+
require_paths:
|
94
|
+
- lib
|
95
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
96
|
+
requirements:
|
97
|
+
- - ">="
|
98
|
+
- !ruby/object:Gem::Version
|
99
|
+
version: '0'
|
100
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ">="
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
requirements: []
|
106
|
+
rubyforge_project:
|
107
|
+
rubygems_version: 2.7.6.2
|
108
|
+
signing_key:
|
109
|
+
specification_version: 4
|
110
|
+
summary: A straightforward documentation site theme for static sites built with Jekyll.
|
111
|
+
test_files: []
|