jekyll-materialdocs 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +46 -0
- data/_includes/footer.html +1 -0
- data/_includes/head.html +105 -0
- data/_includes/menu.html +17 -0
- data/_layouts/default.html +34 -0
- data/_layouts/page.html +5 -0
- metadata +94 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 4ea04d7e2adabb6702c13c26174cdc4f0dec849a
|
4
|
+
data.tar.gz: 16aaefc20a009d04f642cb76b4bdb63af56b7925
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0e9cf4662626fe4bc1cf812ad6c407714dcee49782de8b5e9922926b84d205efa075a8c97f94cbba9455a67a1542c2d5a55bd794b7ded5be837387d08bc1418e
|
7
|
+
data.tar.gz: 9bf9f09137f6b1925e2eddf6feb6da59b9a8d95ca9dda5b54a523087c25d3dd306b009acb7563d626914182d973e0afebcca86c8081bc0939450cf2a5fa1b52d
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 James King
|
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.
|
data/README.md
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# MaterialDocs
|
2
|
+
|
3
|
+
MaterialDocs is a material two-column Jekyll theme designed for documentation websites. It is built with [Material Design Lite](https://getmdl.io).
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your Jekyll site's `Gemfile`:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem "jekyll-materialdocs"
|
11
|
+
```
|
12
|
+
|
13
|
+
And add this line to your Jekyll site's `_config.yml`:
|
14
|
+
|
15
|
+
```yaml
|
16
|
+
theme: jekyll-materialdocs
|
17
|
+
```
|
18
|
+
|
19
|
+
And then execute:
|
20
|
+
|
21
|
+
$ bundle
|
22
|
+
|
23
|
+
Or install it yourself as:
|
24
|
+
|
25
|
+
$ gem install jekyll-materialdocs
|
26
|
+
|
27
|
+
## Usage
|
28
|
+
|
29
|
+
MaterialDocs supports a few optional custom values in the YAML front matter.
|
30
|
+
```yaml
|
31
|
+
menu: Example Page # will use this as the menu item text instead of title
|
32
|
+
parent: index.md # will make this menu item a child of the index.md item
|
33
|
+
weight: 2 # smaller weights rise to the top of the menu
|
34
|
+
```
|
35
|
+
|
36
|
+
MaterialDocs also supports changing the color scheme by setting `mdl_colors` in _config.yml to a supported Material Design Lite scheme (e.g. indigo-pink, deep_orange-blue). Use the [MDL theme builder](https://getmdl.io/customize/index.html) to find color schemes.
|
37
|
+
|
38
|
+
The footer copyright notice may be overridden by setting `copyright` in _config.yml.
|
39
|
+
|
40
|
+
## Contributing
|
41
|
+
|
42
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/chromatical/jekyll-materialdocs.
|
43
|
+
|
44
|
+
## License
|
45
|
+
|
46
|
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
@@ -0,0 +1 @@
|
|
1
|
+
<p id="copyright">© {{ site.time | date: '%Y' }} {% if site.copyright %}{{ site.copyright }}{% else %}{{ site.title }}{% endif %}</p>
|
data/_includes/head.html
ADDED
@@ -0,0 +1,105 @@
|
|
1
|
+
<meta charset="utf-8"/>
|
2
|
+
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>
|
3
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
|
4
|
+
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.{% if site.mdl_colors %}{{ site.mdl_colors }}{% else %}blue-indigo{% endif %}.min.css" />
|
5
|
+
<title>{{ page.title }} | {{ site.title }}</title>
|
6
|
+
<style>
|
7
|
+
#site-title{
|
8
|
+
color: inherit;
|
9
|
+
text-decoration: none;
|
10
|
+
}
|
11
|
+
.mdl-layout__drawer > .mdl-layout-title{
|
12
|
+
padding-right: 16px;
|
13
|
+
text-align: center;
|
14
|
+
}
|
15
|
+
.content{
|
16
|
+
max-width: 800px;
|
17
|
+
padding: 40px 40px 40px 40px;
|
18
|
+
margin-left: auto;
|
19
|
+
margin-right: auto;
|
20
|
+
}
|
21
|
+
.parent{
|
22
|
+
font-weight: bold;
|
23
|
+
}
|
24
|
+
.child{
|
25
|
+
padding: 5px 40px 5px 60px !important;
|
26
|
+
}
|
27
|
+
.is-active{
|
28
|
+
background-color: #e0e0e0;
|
29
|
+
}
|
30
|
+
.content img {
|
31
|
+
max-width: 100%;
|
32
|
+
padding: 10px;
|
33
|
+
border: 1px whitesmoke solid;
|
34
|
+
border-radius: 10px;
|
35
|
+
}
|
36
|
+
footer{
|
37
|
+
text-align: right;
|
38
|
+
padding-right: 10px;
|
39
|
+
}
|
40
|
+
.lineno{
|
41
|
+
padding-right: 8px;
|
42
|
+
}
|
43
|
+
|
44
|
+
/* Copied from Syntax.css (https://github.com/mojombo/tpw/blob/master/css/syntax.css) */
|
45
|
+
.highlight { background: #ffffff; }
|
46
|
+
.highlight .c { color: #999988; font-style: italic } /* Comment */
|
47
|
+
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
48
|
+
.highlight .k { font-weight: bold } /* Keyword */
|
49
|
+
.highlight .o { font-weight: bold } /* Operator */
|
50
|
+
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
51
|
+
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
|
52
|
+
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
|
53
|
+
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
54
|
+
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
55
|
+
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
|
56
|
+
.highlight .ge { font-style: italic } /* Generic.Emph */
|
57
|
+
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
58
|
+
.highlight .gh { color: #999999 } /* Generic.Heading */
|
59
|
+
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
60
|
+
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
|
61
|
+
.highlight .go { color: #888888 } /* Generic.Output */
|
62
|
+
.highlight .gp { color: #555555 } /* Generic.Prompt */
|
63
|
+
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
64
|
+
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
|
65
|
+
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
|
66
|
+
.highlight .kc { font-weight: bold } /* Keyword.Constant */
|
67
|
+
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
|
68
|
+
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
|
69
|
+
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
|
70
|
+
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
71
|
+
.highlight .m { color: #009999 } /* Literal.Number */
|
72
|
+
.highlight .s { color: #d14 } /* Literal.String */
|
73
|
+
.highlight .na { color: #008080 } /* Name.Attribute */
|
74
|
+
.highlight .nb { color: #0086B3 } /* Name.Builtin */
|
75
|
+
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
76
|
+
.highlight .no { color: #008080 } /* Name.Constant */
|
77
|
+
.highlight .ni { color: #800080 } /* Name.Entity */
|
78
|
+
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
79
|
+
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
80
|
+
.highlight .nn { color: #555555 } /* Name.Namespace */
|
81
|
+
.highlight .nt { color: #000080 } /* Name.Tag */
|
82
|
+
.highlight .nv { color: #008080 } /* Name.Variable */
|
83
|
+
.highlight .ow { font-weight: bold } /* Operator.Word */
|
84
|
+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
85
|
+
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
86
|
+
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
87
|
+
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
88
|
+
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
89
|
+
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
|
90
|
+
.highlight .sc { color: #d14 } /* Literal.String.Char */
|
91
|
+
.highlight .sd { color: #d14 } /* Literal.String.Doc */
|
92
|
+
.highlight .s2 { color: #d14 } /* Literal.String.Double */
|
93
|
+
.highlight .se { color: #d14 } /* Literal.String.Escape */
|
94
|
+
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
|
95
|
+
.highlight .si { color: #d14 } /* Literal.String.Interpol */
|
96
|
+
.highlight .sx { color: #d14 } /* Literal.String.Other */
|
97
|
+
.highlight .sr { color: #009926 } /* Literal.String.Regex */
|
98
|
+
.highlight .s1 { color: #d14 } /* Literal.String.Single */
|
99
|
+
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
|
100
|
+
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
101
|
+
.highlight .vc { color: #008080 } /* Name.Variable.Class */
|
102
|
+
.highlight .vg { color: #008080 } /* Name.Variable.Global */
|
103
|
+
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
|
104
|
+
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
105
|
+
</style>
|
data/_includes/menu.html
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
{% assign sorted_pages = site.pages | sort: 'weight'%}
|
2
|
+
{% for node in sorted_pages %}
|
3
|
+
{% if node.menu or node.title %}
|
4
|
+
{% unless node.parent %}
|
5
|
+
<a class="mdl-navigation__link parent {% if node.url == page.url or page.parent == node.path %}is-active{% endif %}" href="{{ node.url | absolute_url }}">{% if node.menu %}{{ node.menu }}{% else %}{{ node.title }}{% endif %}</a>
|
6
|
+
{% for child in sorted_pages %}
|
7
|
+
{% if node.menu or node.title %}
|
8
|
+
{% if child.parent %}
|
9
|
+
{% if child.parent == node.path %}
|
10
|
+
<a class="mdl-navigation__link child {% if child.url == page.url %}is-active{% endif %}" href="{{ child.url | absolute_url }}">{% if child.menu %}{{ child.menu }}{% else %}{{ child.title }}{% endif %}</a>
|
11
|
+
{% endif %}
|
12
|
+
{% endif %}
|
13
|
+
{% endif %}
|
14
|
+
{% endfor %}
|
15
|
+
{% endunless %}
|
16
|
+
{% endif %}
|
17
|
+
{% endfor %}
|
@@ -0,0 +1,34 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
{% include head.html %}
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
|
8
|
+
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer mdl-layout--fixed-header">
|
9
|
+
<header class="mdl-layout__header">
|
10
|
+
<div class="mdl-layout__header-row">
|
11
|
+
<span class="mdl-layout-title">
|
12
|
+
{% if page.title %}<h1 id="page-title" class="mdl-typography--title">{{ page.title }}</h1>{% endif %}
|
13
|
+
</span>
|
14
|
+
</div>
|
15
|
+
</header>
|
16
|
+
<div class="mdl-layout__drawer">
|
17
|
+
<span class="mdl-layout-title"><a id="site-title" href="{{ site.baseurl }}/">{{ site.title }}</a></span>
|
18
|
+
<nav class="mdl-navigation">
|
19
|
+
{% include menu.html %}
|
20
|
+
</nav>
|
21
|
+
</div>
|
22
|
+
<main class="mdl-layout__content">
|
23
|
+
<div class="page-content">
|
24
|
+
<div class="content">
|
25
|
+
{{ content }}
|
26
|
+
</div>
|
27
|
+
</div>
|
28
|
+
</main>
|
29
|
+
<footer>
|
30
|
+
{% include footer.html %}
|
31
|
+
</footer>
|
32
|
+
</div>
|
33
|
+
</body>
|
34
|
+
</html>
|
data/_layouts/page.html
ADDED
metadata
ADDED
@@ -0,0 +1,94 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: jekyll-materialdocs
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- James King
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-05-25 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: '3.4'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3.4'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.12'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.12'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
description:
|
56
|
+
email:
|
57
|
+
- hello@chromaticaldesign.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- LICENSE.txt
|
63
|
+
- README.md
|
64
|
+
- _includes/footer.html
|
65
|
+
- _includes/head.html
|
66
|
+
- _includes/menu.html
|
67
|
+
- _layouts/default.html
|
68
|
+
- _layouts/page.html
|
69
|
+
homepage: https://github.com/chromatical/jekyll-materialdocs
|
70
|
+
licenses:
|
71
|
+
- MIT
|
72
|
+
metadata: {}
|
73
|
+
post_install_message:
|
74
|
+
rdoc_options: []
|
75
|
+
require_paths:
|
76
|
+
- lib
|
77
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ">="
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
requirements: []
|
88
|
+
rubyforge_project:
|
89
|
+
rubygems_version: 2.5.1
|
90
|
+
signing_key:
|
91
|
+
specification_version: 4
|
92
|
+
summary: MaterialDocs is a material two-column Jekyll theme designed for documentation
|
93
|
+
websites.
|
94
|
+
test_files: []
|