jekyll-materialdocs 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 298121eadcf0b06a9fccc6f3087a9a5e594f8e74
-  data.tar.gz: 0132694b73a52bf3af4b6c6a470e74f73b6ff81c
+  metadata.gz: 8633171b81ecec9a99061412fc03e9a5863d4d0d
+  data.tar.gz: 247a1d6d1f5fffa1d4b57d0e5bc064df85fbe1ca
 SHA512:
-  metadata.gz: 135f698e6eeb838d29e422b42f21509c8de220429b7e812a7b3c16b2543d0fec4c47d546edb02657fe68695f43382fa7a7a66f85cbc7ff8f72c4c85cc21c5ed8
-  data.tar.gz: 9baff169616e76912f859a871f300c9a00ad0af39fa4ed6f50c62cb7b468d7c460e333bf7b166c8b95518f41f587269b02a2605780160a428f0dde2ba9ce7f37
+  metadata.gz: 09bc752b0d158fd89c634e54bcd2e45cb2085ac9badaaea908e7c2044afe621eb808eeeb4cf9b6d71a6142dbb92095f2e7438f522954502c93ace7405488ab63
+  data.tar.gz: b758dc6edc1bb92a4cdd470c0902e29f0b3aa26d0d255f2c14b1c55b1cb0bd4f16ce5016498255bec176d0d75a403c0b194cccb7b3b5a9577deae2a564ff6a59

data/README.md

@@ -1,12 +1,12 @@
 # MaterialDocs
 
-**Rate this theme on [ThemeJekyll](https://themejekyll.github.io/theme/materialdocs/)!**
+**View this theme on [ThemeJekyll](https://themejekyll.github.io/theme/materialdocs/)**
 
 ![MaterialDocs Screenshot](https://themejekyll.github.io/assets/screenshots/materialdocs/materialdocs-screenshot-2.jpg)
 
 MaterialDocs is a material two-column Jekyll theme designed for documentation websites.  It is built with [Material Design Lite](https://getmdl.io).
 
-## Installation
+## Standard Installation
 
 Add this line to your Jekyll site's `Gemfile`:
 
@@ -28,19 +28,40 @@ Or install it yourself as:
 
     $ gem install jekyll-materialdocs
 
-## Usage
+## Using with GitHub Pages
+
+MaterialDocs is compatible with [Jekyll Remote Theme](https://github.com/benbalter/jekyll-remote-theme).
+
+Add the following to `_config.yml` to enable Jekyll Remote Theme.
+
+```yaml
+plugins:
+  - jekyll-remote-theme
+```
+
+Add the following to `_config.yml` to use MaterialDocs.
+
+```yaml
+remote_theme: chromatical/jekyll-materialdocs
+```
+
+## Site Options
+```yaml
+mdl_colors: indigo-pink # a supported Material Design Lite color scheme
+copyright: Your Name # will override the copyright notice (default is site_name)
+```
+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.
+
+## Front Matter Options
 
 MaterialDocs supports a few optional custom values in the YAML front matter.
 ```yaml
 menu: Example Page # will use this as the menu item text instead of title
 parent: index.md # will make this menu item a child of the index.md item
 weight: 2 # smaller weights rise to the top of the menu
+mdl_colors: deep_orange-blue # override global color scheme for this page
 ```
 
-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.
-
-The footer copyright notice may be overridden by setting `copyright` in _config.yml.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/chromatical/jekyll-materialdocs.

data/_includes/head.html

@@ -1,109 +1,15 @@
 <meta charset="utf-8"/>
 <script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>
 <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
-<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" />
-<title>{{ page.title }} | {{ site.title }}</title>
-<style>
-#site-title{
-  color: inherit;
-  text-decoration: none;
-}
-.mdl-layout__drawer > .mdl-layout-title{
-  padding-left: 16px;
-  padding-right: 16px;
-  text-align: center;
-  line-height: 32px;
-  margin-top: 32px;
-  margin-bottom: 32px;
-}
-.content{
-  max-width: 800px;
-  padding: 40px 40px 40px 40px;
-  margin-left: auto;
-  margin-right: auto;
-}
-.parent{
-  font-weight: bold;
-}
-.child{
-  padding: 5px 40px 5px 60px !important;
-}
-.is-active{
-  background-color: #e0e0e0;
-}
-.content img, .content video {
-  max-width: 100%;
-  padding: 10px;
-  border: 1px whitesmoke solid;
-  border-radius: 10px;
-}
-footer{
-  text-align: right;
-  padding-right: 10px;
-}
-.lineno{
-  padding-right: 8px;
-}
+{% assign mdl_colors = "blue-indigo" %}
+
+{% if site.mdl_colors %}
+  {% assign mdl_colors = site.mdl_colors %}
+{% endif %}
 
-/* Copied from Syntax.css (https://github.com/mojombo/tpw/blob/master/css/syntax.css) */
-.highlight  { background: #ffffff; }
-.highlight .c { color: #999988; font-style: italic } /* Comment */
-.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
-.highlight .k { font-weight: bold } /* Keyword */
-.highlight .o { font-weight: bold } /* Operator */
-.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
-.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
-.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
-.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
-.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
-.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
-.highlight .ge { font-style: italic } /* Generic.Emph */
-.highlight .gr { color: #aa0000 } /* Generic.Error */
-.highlight .gh { color: #999999 } /* Generic.Heading */
-.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
-.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
-.highlight .go { color: #888888 } /* Generic.Output */
-.highlight .gp { color: #555555 } /* Generic.Prompt */
-.highlight .gs { font-weight: bold } /* Generic.Strong */
-.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
-.highlight .gt { color: #aa0000 } /* Generic.Traceback */
-.highlight .kc { font-weight: bold } /* Keyword.Constant */
-.highlight .kd { font-weight: bold } /* Keyword.Declaration */
-.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
-.highlight .kr { font-weight: bold } /* Keyword.Reserved */
-.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
-.highlight .m { color: #009999 } /* Literal.Number */
-.highlight .s { color: #d14 } /* Literal.String */
-.highlight .na { color: #008080 } /* Name.Attribute */
-.highlight .nb { color: #0086B3 } /* Name.Builtin */
-.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
-.highlight .no { color: #008080 } /* Name.Constant */
-.highlight .ni { color: #800080 } /* Name.Entity */
-.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
-.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
-.highlight .nn { color: #555555 } /* Name.Namespace */
-.highlight .nt { color: #000080 } /* Name.Tag */
-.highlight .nv { color: #008080 } /* Name.Variable */
-.highlight .ow { font-weight: bold } /* Operator.Word */
-.highlight .w { color: #bbbbbb } /* Text.Whitespace */
-.highlight .mf { color: #009999 } /* Literal.Number.Float */
-.highlight .mh { color: #009999 } /* Literal.Number.Hex */
-.highlight .mi { color: #009999 } /* Literal.Number.Integer */
-.highlight .mo { color: #009999 } /* Literal.Number.Oct */
-.highlight .sb { color: #d14 } /* Literal.String.Backtick */
-.highlight .sc { color: #d14 } /* Literal.String.Char */
-.highlight .sd { color: #d14 } /* Literal.String.Doc */
-.highlight .s2 { color: #d14 } /* Literal.String.Double */
-.highlight .se { color: #d14 } /* Literal.String.Escape */
-.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
-.highlight .si { color: #d14 } /* Literal.String.Interpol */
-.highlight .sx { color: #d14 } /* Literal.String.Other */
-.highlight .sr { color: #009926 } /* Literal.String.Regex */
-.highlight .s1 { color: #d14 } /* Literal.String.Single */
-.highlight .ss { color: #990073 } /* Literal.String.Symbol */
-.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
-.highlight .vc { color: #008080 } /* Name.Variable.Class */
-.highlight .vg { color: #008080 } /* Name.Variable.Global */
-.highlight .vi { color: #008080 } /* Name.Variable.Instance */
-.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
-</style>
+{% if page.mdl_colors %}
+  {% assign mdl_colors = page.mdl_colors %}
+{% endif %}
+<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.{{ mdl_colors }}.min.css" />
+<link rel="stylesheet" href="{{ site.baseurl }}/assets/jekyll-materialdocs.css">
+<title>{{ page.title }} | {{ site.title }}</title>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-materialdocs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - James King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: MaterialDocs is a material two-column Jekyll theme designed for documentation