jekyll-materialdocs 1.1.0 → 1.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -7
- data/_includes/head.html +11 -105
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8633171b81ecec9a99061412fc03e9a5863d4d0d
|
|
4
|
+
data.tar.gz: 247a1d6d1f5fffa1d4b57d0e5bc064df85fbe1ca
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 09bc752b0d158fd89c634e54bcd2e45cb2085ac9badaaea908e7c2044afe621eb808eeeb4cf9b6d71a6142dbb92095f2e7438f522954502c93ace7405488ab63
|
|
7
|
+
data.tar.gz: b758dc6edc1bb92a4cdd470c0902e29f0b3aa26d0d255f2c14b1c55b1cb0bd4f16ce5016498255bec176d0d75a403c0b194cccb7b3b5a9577deae2a564ff6a59
|
data/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# MaterialDocs
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**View this theme on [ThemeJekyll](https://themejekyll.github.io/theme/materialdocs/)**
|
|
4
4
|
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
MaterialDocs is a material two-column Jekyll theme designed for documentation websites. It is built with [Material Design Lite](https://getmdl.io).
|
|
8
8
|
|
|
9
|
-
## Installation
|
|
9
|
+
## Standard Installation
|
|
10
10
|
|
|
11
11
|
Add this line to your Jekyll site's `Gemfile`:
|
|
12
12
|
|
|
@@ -28,19 +28,40 @@ Or install it yourself as:
|
|
|
28
28
|
|
|
29
29
|
$ gem install jekyll-materialdocs
|
|
30
30
|
|
|
31
|
-
##
|
|
31
|
+
## Using with GitHub Pages
|
|
32
|
+
|
|
33
|
+
MaterialDocs is compatible with [Jekyll Remote Theme](https://github.com/benbalter/jekyll-remote-theme).
|
|
34
|
+
|
|
35
|
+
Add the following to `_config.yml` to enable Jekyll Remote Theme.
|
|
36
|
+
|
|
37
|
+
```yaml
|
|
38
|
+
plugins:
|
|
39
|
+
- jekyll-remote-theme
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Add the following to `_config.yml` to use MaterialDocs.
|
|
43
|
+
|
|
44
|
+
```yaml
|
|
45
|
+
remote_theme: chromatical/jekyll-materialdocs
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Site Options
|
|
49
|
+
```yaml
|
|
50
|
+
mdl_colors: indigo-pink # a supported Material Design Lite color scheme
|
|
51
|
+
copyright: Your Name # will override the copyright notice (default is site_name)
|
|
52
|
+
```
|
|
53
|
+
MaterialDocs 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.
|
|
54
|
+
|
|
55
|
+
## Front Matter Options
|
|
32
56
|
|
|
33
57
|
MaterialDocs supports a few optional custom values in the YAML front matter.
|
|
34
58
|
```yaml
|
|
35
59
|
menu: Example Page # will use this as the menu item text instead of title
|
|
36
60
|
parent: index.md # will make this menu item a child of the index.md item
|
|
37
61
|
weight: 2 # smaller weights rise to the top of the menu
|
|
62
|
+
mdl_colors: deep_orange-blue # override global color scheme for this page
|
|
38
63
|
```
|
|
39
64
|
|
|
40
|
-
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.
|
|
41
|
-
|
|
42
|
-
The footer copyright notice may be overridden by setting `copyright` in _config.yml.
|
|
43
|
-
|
|
44
65
|
## Contributing
|
|
45
66
|
|
|
46
67
|
Bug reports and pull requests are welcome on GitHub at https://github.com/chromatical/jekyll-materialdocs.
|
data/_includes/head.html
CHANGED
|
@@ -1,109 +1,15 @@
|
|
|
1
1
|
<meta charset="utf-8"/>
|
|
2
2
|
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>
|
|
3
3
|
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
text-decoration: none;
|
|
10
|
-
}
|
|
11
|
-
.mdl-layout__drawer > .mdl-layout-title{
|
|
12
|
-
padding-left: 16px;
|
|
13
|
-
padding-right: 16px;
|
|
14
|
-
text-align: center;
|
|
15
|
-
line-height: 32px;
|
|
16
|
-
margin-top: 32px;
|
|
17
|
-
margin-bottom: 32px;
|
|
18
|
-
}
|
|
19
|
-
.content{
|
|
20
|
-
max-width: 800px;
|
|
21
|
-
padding: 40px 40px 40px 40px;
|
|
22
|
-
margin-left: auto;
|
|
23
|
-
margin-right: auto;
|
|
24
|
-
}
|
|
25
|
-
.parent{
|
|
26
|
-
font-weight: bold;
|
|
27
|
-
}
|
|
28
|
-
.child{
|
|
29
|
-
padding: 5px 40px 5px 60px !important;
|
|
30
|
-
}
|
|
31
|
-
.is-active{
|
|
32
|
-
background-color: #e0e0e0;
|
|
33
|
-
}
|
|
34
|
-
.content img, .content video {
|
|
35
|
-
max-width: 100%;
|
|
36
|
-
padding: 10px;
|
|
37
|
-
border: 1px whitesmoke solid;
|
|
38
|
-
border-radius: 10px;
|
|
39
|
-
}
|
|
40
|
-
footer{
|
|
41
|
-
text-align: right;
|
|
42
|
-
padding-right: 10px;
|
|
43
|
-
}
|
|
44
|
-
.lineno{
|
|
45
|
-
padding-right: 8px;
|
|
46
|
-
}
|
|
4
|
+
{% assign mdl_colors = "blue-indigo" %}
|
|
5
|
+
|
|
6
|
+
{% if site.mdl_colors %}
|
|
7
|
+
{% assign mdl_colors = site.mdl_colors %}
|
|
8
|
+
{% endif %}
|
|
47
9
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
|
55
|
-
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
|
|
56
|
-
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
|
|
57
|
-
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
|
58
|
-
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
|
59
|
-
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
|
|
60
|
-
.highlight .ge { font-style: italic } /* Generic.Emph */
|
|
61
|
-
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
|
62
|
-
.highlight .gh { color: #999999 } /* Generic.Heading */
|
|
63
|
-
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
|
64
|
-
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
|
|
65
|
-
.highlight .go { color: #888888 } /* Generic.Output */
|
|
66
|
-
.highlight .gp { color: #555555 } /* Generic.Prompt */
|
|
67
|
-
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
|
68
|
-
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
|
|
69
|
-
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
|
|
70
|
-
.highlight .kc { font-weight: bold } /* Keyword.Constant */
|
|
71
|
-
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
|
|
72
|
-
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
|
|
73
|
-
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
|
|
74
|
-
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
|
75
|
-
.highlight .m { color: #009999 } /* Literal.Number */
|
|
76
|
-
.highlight .s { color: #d14 } /* Literal.String */
|
|
77
|
-
.highlight .na { color: #008080 } /* Name.Attribute */
|
|
78
|
-
.highlight .nb { color: #0086B3 } /* Name.Builtin */
|
|
79
|
-
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
|
80
|
-
.highlight .no { color: #008080 } /* Name.Constant */
|
|
81
|
-
.highlight .ni { color: #800080 } /* Name.Entity */
|
|
82
|
-
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
|
83
|
-
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
|
84
|
-
.highlight .nn { color: #555555 } /* Name.Namespace */
|
|
85
|
-
.highlight .nt { color: #000080 } /* Name.Tag */
|
|
86
|
-
.highlight .nv { color: #008080 } /* Name.Variable */
|
|
87
|
-
.highlight .ow { font-weight: bold } /* Operator.Word */
|
|
88
|
-
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
|
89
|
-
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
|
90
|
-
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
|
91
|
-
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
|
92
|
-
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
|
93
|
-
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
|
|
94
|
-
.highlight .sc { color: #d14 } /* Literal.String.Char */
|
|
95
|
-
.highlight .sd { color: #d14 } /* Literal.String.Doc */
|
|
96
|
-
.highlight .s2 { color: #d14 } /* Literal.String.Double */
|
|
97
|
-
.highlight .se { color: #d14 } /* Literal.String.Escape */
|
|
98
|
-
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
|
|
99
|
-
.highlight .si { color: #d14 } /* Literal.String.Interpol */
|
|
100
|
-
.highlight .sx { color: #d14 } /* Literal.String.Other */
|
|
101
|
-
.highlight .sr { color: #009926 } /* Literal.String.Regex */
|
|
102
|
-
.highlight .s1 { color: #d14 } /* Literal.String.Single */
|
|
103
|
-
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
|
|
104
|
-
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
|
105
|
-
.highlight .vc { color: #008080 } /* Name.Variable.Class */
|
|
106
|
-
.highlight .vg { color: #008080 } /* Name.Variable.Global */
|
|
107
|
-
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
|
|
108
|
-
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
|
109
|
-
</style>
|
|
10
|
+
{% if page.mdl_colors %}
|
|
11
|
+
{% assign mdl_colors = page.mdl_colors %}
|
|
12
|
+
{% endif %}
|
|
13
|
+
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.{{ mdl_colors }}.min.css" />
|
|
14
|
+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/jekyll-materialdocs.css">
|
|
15
|
+
<title>{{ page.title }} | {{ site.title }}</title>
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-materialdocs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.1.
|
|
4
|
+
version: 1.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- James King
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2018-03-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
86
86
|
version: '0'
|
|
87
87
|
requirements: []
|
|
88
88
|
rubyforge_project:
|
|
89
|
-
rubygems_version: 2.5.1
|
|
89
|
+
rubygems_version: 2.5.2.1
|
|
90
90
|
signing_key:
|
|
91
91
|
specification_version: 4
|
|
92
92
|
summary: MaterialDocs is a material two-column Jekyll theme designed for documentation
|