Skip to content

Commit b7b0d0d

Browse files
pmarsceillpmarsceill
committed
Initial commit
0 parents  commit b7b0d0d

File tree

4,147 files changed

+401224
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,147 files changed

+401224
-0
lines changed

‎.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*.gem
2+
.bundle
3+
.sass-cache
4+
_site
5+
Gemfile.lock

‎.stylelintrc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"extends": [
3+
"stylelint-config-primer"
4+
]
5+
}

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source "https://rubygems.org"
2+
gemspec

‎LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 Patrick Marsceill
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
13+
all 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
21+
THE SOFTWARE.

‎README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# just-the-docs
2+
3+
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes` and your sass in `_sass`. To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
4+
5+
TODO: Delete this and the text above, and describe your gem
6+
7+
## Installation
8+
9+
Add this line to your Jekyll site's Gemfile:
10+
11+
```ruby
12+
gem "just-the-docs"
13+
```
14+
15+
And add this line to your Jekyll site's `_config.yml`:
16+
17+
```yaml
18+
theme: just-the-docs
19+
```
20+
21+
And then execute:
22+
23+
$ bundle
24+
25+
Or install it yourself as:
26+
27+
$ gem install just-the-docs
28+
29+
## Usage
30+
31+
TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
32+
33+
## Contributing
34+
35+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36+
37+
## Development
38+
39+
To set up your environment to develop this theme, run `bundle install`.
40+
41+
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
42+
43+
When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
44+
45+
## License
46+
47+
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
48+

‎_config.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Welcome to Jekyll!
2+
#
3+
# This config file is meant for settings that affect your whole site, values
4+
# which you are expected to set up once and rarely edit after that. If you find
5+
# yourself editing these this file very often, consider using Jekyll's data files
6+
# feature for the data you need to update frequently.
7+
#
8+
# For technical reasons, this file is *NOT* reloaded automatically when you use
9+
# 'jekyll serve'. If you change this file, please restart the server process.
10+
11+
# Site settings
12+
# These are used to personalize your new site. If you look in the HTML files,
13+
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
14+
# You can create any custom variable you would like, and they will be accessible
15+
# in the templates via {{ site.myvariable }}.
16+
title: Just the docs
17+
description: A Jekyll theme for documentation
18+
# baseurl: "" # the subpath of your site, e.g. /blog
19+
# url: "" # the base hostname & protocol for your site, e.g. http://example.com
20+
21+
sass:
22+
# Load dependancies
23+
load_paths:
24+
- node_modules/
25+
26+
exclude: ["node_modules/", "*.gemspec", "Gemfile", "Gemfile.lock", "package.json", "LICENSE.txt"]

‎_includes/head.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<head>
2+
<meta charset="UTF-8">
3+
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
4+
5+
<title>{{ page.title }} - {{ site.title }}</title>
6+
<link rel="stylesheet" href="/assets/css/just-the-docs.css">
7+
8+
</head>

‎_includes/nav.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<nav>
2+
<ul class="navigation-list">
3+
{% assign pages_list = site.pages | sort:"nav_order"%}
4+
{% for node in pages_list %}
5+
<li class="navigation-list-item{% if page.url == node.url %} active{% endif %} js-side-nav-item">
6+
{% if node.parent == nil or node.has_children == true %}
7+
<a href="{{ node.url | absolute_url }}" class="navigation-list-link{% if page.url == node.url or (page.parent != nil and page.parent == node.parent) %} active{% endif %}">{{ node.title }}</a>
8+
{% if (node.has_children == true and node.parent == page.parent) %}
9+
{% assign children_list = site.pages | sort:"nav_order" %}
10+
<ul class="navigation-list-child-list">
11+
{% for child in children_list %}
12+
{% if child.parent == node.parent and child.title != node.title %}
13+
<li class="navigation-list-item">
14+
<a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
15+
</li>
16+
{% endif %}
17+
{% endfor %}
18+
</ul>
19+
{% endif %}
20+
{% endif %}
21+
</li>
22+
{% endfor %}
23+
</ul>
24+
</nav>

‎_layouts/default.html

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!DOCTYPE html>
2+
3+
<html lang="en-us">
4+
{% include head.html %}
5+
6+
<div class="page-wrap">
7+
<div class="side-bar">
8+
<a href="{{ site.url }}" class="site-title fs-6 fw-300 text-grey-dk-300">Just the <span class="fw-700">/docs</span></a>
9+
<div class="navigation">
10+
{% include nav.html %}
11+
</div>
12+
<footer role="contentinfo" class="site-footer">
13+
<p class="text-small text-grey-dk-000">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
14+
</footer>
15+
16+
</div>
17+
<div class="main-content-wrap">
18+
<div class="main-content">
19+
{% unless page.url == "/" %}
20+
<nav>
21+
<ol class="breadcrumb-nav-list">
22+
<li class="breadcrumb-nav-list-item"><a href="{{ site.url }}">Home</a></li>
23+
{% if page.parent != nil and page.parent != page.title %}
24+
<li class="breadcrumb-nav-list-item"><a href="{{ site.url }}/{{ page.parent | slugify }}">{{ page.parent }}</a></li>
25+
{% endif %}
26+
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
27+
</ol>
28+
</nav>
29+
{% endunless %}
30+
{{ content }}
31+
32+
{% if page.has_children == true %}
33+
<hr>
34+
<h2 class="text-delta">Table of contents</h2>
35+
{% assign children_list = site.pages | sort:"nav_order" %}
36+
<ol>
37+
{% for child in children_list %}
38+
{% if child.parent == page.title and child.title != page.title %}
39+
<li>
40+
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>
41+
</li>
42+
{% endif %}
43+
{% endfor %}
44+
</ol>
45+
{% endif %}
46+
</div>
47+
</div>
48+
</div>
49+
50+
</html>

‎_layouts/post.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
layout: default
3+
---
4+
5+
{{ content }}

‎_sass/base.scss

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
// stylelint-disable selector-no-type
2+
3+
* {
4+
box-sizing: border-box;
5+
}
6+
7+
html {
8+
font-size: $root-font-size;
9+
}
10+
11+
body {
12+
font-family: $body-font-family;
13+
font-size: inherit;
14+
line-height: 1.4;
15+
color: $body-text-color;
16+
}
17+
18+
h1,
19+
h2,
20+
h3,
21+
h4,
22+
h5,
23+
h6 {
24+
font-weight: 500;
25+
color: $body-heading-color;
26+
line-height: 1.1;
27+
margin-bottom: .8em;
28+
29+
&:not(:first-child) {
30+
margin-top: 1.2 em;
31+
}
32+
}
33+
34+
p {
35+
margin-bottom: 1em;
36+
}
37+
38+
p,
39+
h1,
40+
h2,
41+
h3,
42+
h4,
43+
h5,
44+
h6,
45+
ol,
46+
ul,
47+
pre,
48+
address,
49+
blockquote,
50+
dl,
51+
div,
52+
fieldset,
53+
form,
54+
hr,
55+
noscript,
56+
table {
57+
margin-top: 0;
58+
}
59+
60+
a {
61+
color: $link-color;
62+
text-decoration: none;
63+
}
64+
65+
pre,
66+
code {
67+
font-size: 90%;
68+
line-height: 1.3;
69+
font-family: $mono-font-family;
70+
}
71+
72+
li {
73+
margin: 0.25em 0;
74+
}
75+
76+
img {
77+
max-width: 100%;
78+
height: auto;
79+
}

‎_sass/code.scss

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
code {
2+
background-color: $grey-lt-000;
3+
padding: 0.2em 0.15em;
4+
border: $border $border-color;
5+
border-radius: $border-radius;
6+
}
7+
8+
.highlight {
9+
background-color: $grey-lt-000;
10+
padding: $sp-3;
11+
12+
code {
13+
border: 0;
14+
padding: 0;
15+
}
16+
}
17+
18+
.highlight .c { color: #586E75 } /* Comment */
19+
.highlight .err { color: #93A1A1 } /* Error */
20+
.highlight .g { color: #93A1A1 } /* Generic */
21+
.highlight .k { color: #859900 } /* Keyword */
22+
.highlight .l { color: #93A1A1 } /* Literal */
23+
.highlight .n { color: #93A1A1 } /* Name */
24+
.highlight .o { color: #859900 } /* Operator */
25+
.highlight .x { color: #CB4B16 } /* Other */
26+
.highlight .p { color: #93A1A1 } /* Punctuation */
27+
.highlight .cm { color: #586E75 } /* Comment.Multiline */
28+
.highlight .cp { color: #859900 } /* Comment.Preproc */
29+
.highlight .c1 { color: #586E75 } /* Comment.Single */
30+
.highlight .cs { color: #859900 } /* Comment.Special */
31+
.highlight .gd { color: #2AA198 } /* Generic.Deleted */
32+
.highlight .ge { color: #93A1A1; font-style: italic } /* Generic.Emph */
33+
.highlight .gr { color: #DC322F } /* Generic.Error */
34+
.highlight .gh { color: #CB4B16 } /* Generic.Heading */
35+
.highlight .gi { color: #859900 } /* Generic.Inserted */
36+
.highlight .go { color: #93A1A1 } /* Generic.Output */
37+
.highlight .gp { color: #93A1A1 } /* Generic.Prompt */
38+
.highlight .gs { color: #93A1A1; font-weight: bold } /* Generic.Strong */
39+
.highlight .gu { color: #CB4B16 } /* Generic.Subheading */
40+
.highlight .gt { color: #93A1A1 } /* Generic.Traceback */
41+
.highlight .kc { color: #CB4B16 } /* Keyword.Constant */
42+
.highlight .kd { color: #268BD2 } /* Keyword.Declaration */
43+
.highlight .kn { color: #859900 } /* Keyword.Namespace */
44+
.highlight .kp { color: #859900 } /* Keyword.Pseudo */
45+
.highlight .kr { color: #268BD2 } /* Keyword.Reserved */
46+
.highlight .kt { color: #DC322F } /* Keyword.Type */
47+
.highlight .ld { color: #93A1A1 } /* Literal.Date */
48+
.highlight .m { color: #2AA198 } /* Literal.Number */
49+
.highlight .s { color: #2AA198 } /* Literal.String */
50+
.highlight .na { color: #93A1A1 } /* Name.Attribute */
51+
.highlight .nb { color: #B58900 } /* Name.Builtin */
52+
.highlight .nc { color: #268BD2 } /* Name.Class */
53+
.highlight .no { color: #CB4B16 } /* Name.Constant */
54+
.highlight .nd { color: #268BD2 } /* Name.Decorator */
55+
.highlight .ni { color: #CB4B16 } /* Name.Entity */
56+
.highlight .ne { color: #CB4B16 } /* Name.Exception */
57+
.highlight .nf { color: #268BD2 } /* Name.Function */
58+
.highlight .nl { color: #93A1A1 } /* Name.Label */
59+
.highlight .nn { color: #93A1A1 } /* Name.Namespace */
60+
.highlight .nx { color: #555 } /* Name.Other */
61+
.highlight .py { color: #93A1A1 } /* Name.Property */
62+
.highlight .nt { color: #268BD2 } /* Name.Tag */
63+
.highlight .nv { color: #268BD2 } /* Name.Variable */
64+
.highlight .ow { color: #859900 } /* Operator.Word */
65+
.highlight .w { color: #93A1A1 } /* Text.Whitespace */
66+
.highlight .mf { color: #2AA198 } /* Literal.Number.Float */
67+
.highlight .mh { color: #2AA198 } /* Literal.Number.Hex */
68+
.highlight .mi { color: #2AA198 } /* Literal.Number.Integer */
69+
.highlight .mo { color: #2AA198 } /* Literal.Number.Oct */
70+
.highlight .sb { color: #586E75 } /* Literal.String.Backtick */
71+
.highlight .sc { color: #2AA198 } /* Literal.String.Char */
72+
.highlight .sd { color: #93A1A1 } /* Literal.String.Doc */
73+
.highlight .s2 { color: #2AA198 } /* Literal.String.Double */
74+
.highlight .se { color: #CB4B16 } /* Literal.String.Escape */
75+
.highlight .sh { color: #93A1A1 } /* Literal.String.Heredoc */
76+
.highlight .si { color: #2AA198 } /* Literal.String.Interpol */
77+
.highlight .sx { color: #2AA198 } /* Literal.String.Other */
78+
.highlight .sr { color: #DC322F } /* Literal.String.Regex */
79+
.highlight .s1 { color: #2AA198 } /* Literal.String.Single */
80+
.highlight .ss { color: #2AA198 } /* Literal.String.Symbol */
81+
.highlight .bp { color: #268BD2 } /* Name.Builtin.Pseudo */
82+
.highlight .vc { color: #268BD2 } /* Name.Variable.Class */
83+
.highlight .vg { color: #268BD2 } /* Name.Variable.Global */
84+
.highlight .vi { color: #268BD2 } /* Name.Variable.Instance */
85+
.highlight .il { color: #2AA198 } /* Literal.Number.Integer.Long */

0 commit comments

Comments
 (0)