forked from just-the-docs/just-the-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b7b0d0d
Showing
4,147 changed files
with
401,224 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
*.gem | ||
.bundle | ||
.sass-cache | ||
_site | ||
Gemfile.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"extends": [ | ||
"stylelint-config-primer" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
source "https://rubygems.org" | ||
gemspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2016 Patrick Marsceill | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# just-the-docs | ||
|
||
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! | ||
|
||
TODO: Delete this and the text above, and describe your gem | ||
|
||
## Installation | ||
|
||
Add this line to your Jekyll site's Gemfile: | ||
|
||
```ruby | ||
gem "just-the-docs" | ||
``` | ||
|
||
And add this line to your Jekyll site's `_config.yml`: | ||
|
||
```yaml | ||
theme: just-the-docs | ||
``` | ||
And then execute: | ||
$ bundle | ||
Or install it yourself as: | ||
$ gem install just-the-docs | ||
## Usage | ||
TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass. | ||
## Contributing | ||
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. | ||
## Development | ||
To set up your environment to develop this theme, run `bundle install`. | ||
|
||
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. | ||
|
||
When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released. | ||
|
||
## License | ||
|
||
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Welcome to Jekyll! | ||
# | ||
# This config file is meant for settings that affect your whole site, values | ||
# which you are expected to set up once and rarely edit after that. If you find | ||
# yourself editing these this file very often, consider using Jekyll's data files | ||
# feature for the data you need to update frequently. | ||
# | ||
# For technical reasons, this file is *NOT* reloaded automatically when you use | ||
# 'jekyll serve'. If you change this file, please restart the server process. | ||
|
||
# Site settings | ||
# These are used to personalize your new site. If you look in the HTML files, | ||
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on. | ||
# You can create any custom variable you would like, and they will be accessible | ||
# in the templates via {{ site.myvariable }}. | ||
title: Just the docs | ||
description: A Jekyll theme for documentation | ||
# baseurl: "" # the subpath of your site, e.g. /blog | ||
# url: "" # the base hostname & protocol for your site, e.g. http://example.com | ||
|
||
sass: | ||
# Load dependancies | ||
load_paths: | ||
- node_modules/ | ||
|
||
exclude: ["node_modules/", "*.gemspec", "Gemfile", "Gemfile.lock", "package.json", "LICENSE.txt"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<head> | ||
<meta charset="UTF-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=Edge"> | ||
|
||
<title>{{ page.title }} - {{ site.title }}</title> | ||
<link rel="stylesheet" href="/assets/css/just-the-docs.css"> | ||
|
||
</head> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<nav> | ||
<ul class="navigation-list"> | ||
{% assign pages_list = site.pages | sort:"nav_order"%} | ||
{% for node in pages_list %} | ||
<li class="navigation-list-item{% if page.url == node.url %} active{% endif %} js-side-nav-item"> | ||
{% if node.parent == nil or node.has_children == true %} | ||
<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> | ||
{% if (node.has_children == true and node.parent == page.parent) %} | ||
{% assign children_list = site.pages | sort:"nav_order" %} | ||
<ul class="navigation-list-child-list"> | ||
{% for child in children_list %} | ||
{% if child.parent == node.parent and child.title != node.title %} | ||
<li class="navigation-list-item"> | ||
<a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a> | ||
</li> | ||
{% endif %} | ||
{% endfor %} | ||
</ul> | ||
{% endif %} | ||
{% endif %} | ||
</li> | ||
{% endfor %} | ||
</ul> | ||
</nav> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
<!DOCTYPE html> | ||
|
||
<html lang="en-us"> | ||
{% include head.html %} | ||
|
||
<div class="page-wrap"> | ||
<div class="side-bar"> | ||
<a href="{{ site.url }}" class="site-title fs-6 fw-300 text-grey-dk-300">Just the <span class="fw-700">/docs</span></a> | ||
<div class="navigation"> | ||
{% include nav.html %} | ||
</div> | ||
<footer role="contentinfo" class="site-footer"> | ||
<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> | ||
</footer> | ||
|
||
</div> | ||
<div class="main-content-wrap"> | ||
<div class="main-content"> | ||
{% unless page.url == "/" %} | ||
<nav> | ||
<ol class="breadcrumb-nav-list"> | ||
<li class="breadcrumb-nav-list-item"><a href="{{ site.url }}">Home</a></li> | ||
{% if page.parent != nil and page.parent != page.title %} | ||
<li class="breadcrumb-nav-list-item"><a href="{{ site.url }}/{{ page.parent | slugify }}">{{ page.parent }}</a></li> | ||
{% endif %} | ||
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li> | ||
</ol> | ||
</nav> | ||
{% endunless %} | ||
{{ content }} | ||
|
||
{% if page.has_children == true %} | ||
<hr> | ||
<h2 class="text-delta">Table of contents</h2> | ||
{% assign children_list = site.pages | sort:"nav_order" %} | ||
<ol> | ||
{% for child in children_list %} | ||
{% if child.parent == page.title and child.title != page.title %} | ||
<li> | ||
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a> | ||
</li> | ||
{% endif %} | ||
{% endfor %} | ||
</ol> | ||
{% endif %} | ||
</div> | ||
</div> | ||
</div> | ||
|
||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: default | ||
--- | ||
|
||
{{ content }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
// stylelint-disable selector-no-type | ||
|
||
* { | ||
box-sizing: border-box; | ||
} | ||
|
||
html { | ||
font-size: $root-font-size; | ||
} | ||
|
||
body { | ||
font-family: $body-font-family; | ||
font-size: inherit; | ||
line-height: 1.4; | ||
color: $body-text-color; | ||
} | ||
|
||
h1, | ||
h2, | ||
h3, | ||
h4, | ||
h5, | ||
h6 { | ||
font-weight: 500; | ||
color: $body-heading-color; | ||
line-height: 1.1; | ||
margin-bottom: .8em; | ||
|
||
&:not(:first-child) { | ||
margin-top: 1.2 em; | ||
} | ||
} | ||
|
||
p { | ||
margin-bottom: 1em; | ||
} | ||
|
||
p, | ||
h1, | ||
h2, | ||
h3, | ||
h4, | ||
h5, | ||
h6, | ||
ol, | ||
ul, | ||
pre, | ||
address, | ||
blockquote, | ||
dl, | ||
div, | ||
fieldset, | ||
form, | ||
hr, | ||
noscript, | ||
table { | ||
margin-top: 0; | ||
} | ||
|
||
a { | ||
color: $link-color; | ||
text-decoration: none; | ||
} | ||
|
||
pre, | ||
code { | ||
font-size: 90%; | ||
line-height: 1.3; | ||
font-family: $mono-font-family; | ||
} | ||
|
||
li { | ||
margin: 0.25em 0; | ||
} | ||
|
||
img { | ||
max-width: 100%; | ||
height: auto; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
code { | ||
background-color: $grey-lt-000; | ||
padding: 0.2em 0.15em; | ||
border: $border $border-color; | ||
border-radius: $border-radius; | ||
} | ||
|
||
.highlight { | ||
background-color: $grey-lt-000; | ||
padding: $sp-3; | ||
|
||
code { | ||
border: 0; | ||
padding: 0; | ||
} | ||
} | ||
|
||
.highlight .c { color: #586E75 } /* Comment */ | ||
.highlight .err { color: #93A1A1 } /* Error */ | ||
.highlight .g { color: #93A1A1 } /* Generic */ | ||
.highlight .k { color: #859900 } /* Keyword */ | ||
.highlight .l { color: #93A1A1 } /* Literal */ | ||
.highlight .n { color: #93A1A1 } /* Name */ | ||
.highlight .o { color: #859900 } /* Operator */ | ||
.highlight .x { color: #CB4B16 } /* Other */ | ||
.highlight .p { color: #93A1A1 } /* Punctuation */ | ||
.highlight .cm { color: #586E75 } /* Comment.Multiline */ | ||
.highlight .cp { color: #859900 } /* Comment.Preproc */ | ||
.highlight .c1 { color: #586E75 } /* Comment.Single */ | ||
.highlight .cs { color: #859900 } /* Comment.Special */ | ||
.highlight .gd { color: #2AA198 } /* Generic.Deleted */ | ||
.highlight .ge { color: #93A1A1; font-style: italic } /* Generic.Emph */ | ||
.highlight .gr { color: #DC322F } /* Generic.Error */ | ||
.highlight .gh { color: #CB4B16 } /* Generic.Heading */ | ||
.highlight .gi { color: #859900 } /* Generic.Inserted */ | ||
.highlight .go { color: #93A1A1 } /* Generic.Output */ | ||
.highlight .gp { color: #93A1A1 } /* Generic.Prompt */ | ||
.highlight .gs { color: #93A1A1; font-weight: bold } /* Generic.Strong */ | ||
.highlight .gu { color: #CB4B16 } /* Generic.Subheading */ | ||
.highlight .gt { color: #93A1A1 } /* Generic.Traceback */ | ||
.highlight .kc { color: #CB4B16 } /* Keyword.Constant */ | ||
.highlight .kd { color: #268BD2 } /* Keyword.Declaration */ | ||
.highlight .kn { color: #859900 } /* Keyword.Namespace */ | ||
.highlight .kp { color: #859900 } /* Keyword.Pseudo */ | ||
.highlight .kr { color: #268BD2 } /* Keyword.Reserved */ | ||
.highlight .kt { color: #DC322F } /* Keyword.Type */ | ||
.highlight .ld { color: #93A1A1 } /* Literal.Date */ | ||
.highlight .m { color: #2AA198 } /* Literal.Number */ | ||
.highlight .s { color: #2AA198 } /* Literal.String */ | ||
.highlight .na { color: #93A1A1 } /* Name.Attribute */ | ||
.highlight .nb { color: #B58900 } /* Name.Builtin */ | ||
.highlight .nc { color: #268BD2 } /* Name.Class */ | ||
.highlight .no { color: #CB4B16 } /* Name.Constant */ | ||
.highlight .nd { color: #268BD2 } /* Name.Decorator */ | ||
.highlight .ni { color: #CB4B16 } /* Name.Entity */ | ||
.highlight .ne { color: #CB4B16 } /* Name.Exception */ | ||
.highlight .nf { color: #268BD2 } /* Name.Function */ | ||
.highlight .nl { color: #93A1A1 } /* Name.Label */ | ||
.highlight .nn { color: #93A1A1 } /* Name.Namespace */ | ||
.highlight .nx { color: #555 } /* Name.Other */ | ||
.highlight .py { color: #93A1A1 } /* Name.Property */ | ||
.highlight .nt { color: #268BD2 } /* Name.Tag */ | ||
.highlight .nv { color: #268BD2 } /* Name.Variable */ | ||
.highlight .ow { color: #859900 } /* Operator.Word */ | ||
.highlight .w { color: #93A1A1 } /* Text.Whitespace */ | ||
.highlight .mf { color: #2AA198 } /* Literal.Number.Float */ | ||
.highlight .mh { color: #2AA198 } /* Literal.Number.Hex */ | ||
.highlight .mi { color: #2AA198 } /* Literal.Number.Integer */ | ||
.highlight .mo { color: #2AA198 } /* Literal.Number.Oct */ | ||
.highlight .sb { color: #586E75 } /* Literal.String.Backtick */ | ||
.highlight .sc { color: #2AA198 } /* Literal.String.Char */ | ||
.highlight .sd { color: #93A1A1 } /* Literal.String.Doc */ | ||
.highlight .s2 { color: #2AA198 } /* Literal.String.Double */ | ||
.highlight .se { color: #CB4B16 } /* Literal.String.Escape */ | ||
.highlight .sh { color: #93A1A1 } /* Literal.String.Heredoc */ | ||
.highlight .si { color: #2AA198 } /* Literal.String.Interpol */ | ||
.highlight .sx { color: #2AA198 } /* Literal.String.Other */ | ||
.highlight .sr { color: #DC322F } /* Literal.String.Regex */ | ||
.highlight .s1 { color: #2AA198 } /* Literal.String.Single */ | ||
.highlight .ss { color: #2AA198 } /* Literal.String.Symbol */ | ||
.highlight .bp { color: #268BD2 } /* Name.Builtin.Pseudo */ | ||
.highlight .vc { color: #268BD2 } /* Name.Variable.Class */ | ||
.highlight .vg { color: #268BD2 } /* Name.Variable.Global */ | ||
.highlight .vi { color: #268BD2 } /* Name.Variable.Instance */ | ||
.highlight .il { color: #2AA198 } /* Literal.Number.Integer.Long */ |
Oops, something went wrong.