jekyll-theme-material-docs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bb6aca407aee9a966de974aa8517f6b77bd733e9a7151b09538913c3af034c2
+  data.tar.gz: 5c3144420f2cde3c07a8e8226a596155541e45ce561e4ec1b429de325368557a
+SHA512:
+  metadata.gz: e33369c4a29bc89cd366d32a15b62b87d806c38c473c2fc0507c5fc3476d5cd4f6e66b0ed4475f5215f6447c5df1b36cfd4fd7c6535ab08cbd23f4ff4fb2803a
+  data.tar.gz: 91c8247265903209f153d8787a6a234e3867da3d0637ab03bacdf2086fc1c3903a686bebfb1042b97a7afce6755140cc65a28f9db24f51ae0277c929d7db7843

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Fernando Pasik
+
+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.

data/README.md

@@ -0,0 +1,46 @@
+# Material Docs
+
+Jekyll theme built with material web components
+
+## Installation
+
+### Via remote theme
+
+Add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+remote_theme: fernandopasik/jekyll-theme-material-docs
+
+plugins:
+  - jekyll-remote-theme
+```
+
+### Via gems
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-material-docs"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-material-docs
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install jekyll-theme-material-docs
+```
+
+## License
+
+MIT (c) 2020 [Fernando Pasik](https://fernandopasik.com)

data/_includes/content-table.html

@@ -0,0 +1,29 @@
+<nav>
+	<ul class="mdc-list mdc-list-group">
+		{% for item in site.content_table %} {% if item.url %}
+		<li>
+			<a class="mdc-list-item" href="{{ item.url | escape | relative_url }}">
+				<span class="mdc-list-item__ripple"></span>
+				<span class="mdc-list-item__text">{{ item.title }}</span>
+			</a>
+		</li>
+		{% else %}
+		<li class="mdc-list-group__subheader">
+			<p class="mdc-typography--headline6">{{ item.title }}</p>
+
+			{% if item.links %}
+			<ul class="mdc-list">
+				{% for subitem in item.links %}
+				<li>
+					<a class="mdc-list-item" href="{{ subitem.url | escape | relative_url }}">
+						<span class="mdc-list-item__ripple"></span>
+						<span class="mdc-list-item__text">{{ subitem.title }}</span>
+					</a>
+				</li>
+				{% endfor %}
+			</ul>
+			{% endif %}
+		</li>
+		{% endif %} {% endfor %}
+	</ul>
+</nav>

data/_includes/content.html

@@ -0,0 +1,2 @@
+{{ content | replace: '<h2', '<h2 class="mdc-typography--headline3"' | replace: '<h3', '<h3
+class="mdc-typography--headline4"' | replace: '<h4', '<h4 class="mdc-typography--headline5"' }}

data/_includes/footer.html

@@ -0,0 +1,28 @@
+<div class="mdc-layout-grid text-center grid-container">
+	<p>
+		{% if site.twitter %}
+		<a
+			href="https://twitter.com/{{ site.twitter | escape }}"
+			class="mdc-icon-button"
+			aria-label="{{ site.title }} Twitter Link"
+		>
+			{% include twitter-icon.html %}
+		</a>
+		{% endif %}
+		<a
+			href="{{ site.github.repository_url }}"
+			class="mdc-icon-button"
+			aria-label="{{ site.title }} Github Repository Link"
+		>
+			{% include github-icon.html %}
+		</a>
+	</p>
+	<p>
+		{% include made-with-love.html %}
+	</p>
+	{%- if site.github.license -%}
+	<p>
+		{% include license.html %}
+	</p>
+	{%- endif -%}
+</div>

data/_includes/github-icon.html

@@ -0,0 +1,6 @@
+<svg height="32" width="32" viewBox="0 0 16 16" aria-hidden="true">
+	<path
+		fill-rule="evenodd"
+		d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
+	></path>
+</svg>

data/_includes/google-analytics.html

@@ -0,0 +1,14 @@
+{%- if jekyll.environment == 'production' and site.google_analytics -%}
+<script
+	async
+	src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"
+></script>
+<script>
+	window.dataLayer = window.dataLayer || [];
+	function gtag() {
+		dataLayer.push(arguments);
+	}
+	gtag('js', new Date());
+	gtag('config', '{{ site.google_analytics }}');
+</script>
+{%- endif -%}

data/_includes/head.html

@@ -0,0 +1,14 @@
+<head>
+	<meta charset="utf-8" />
+	<meta name="viewport" content="width=device-width, initial-scale=1" />
+
+	<link rel="stylesheet" href="https://unpkg.com/normalize.css" />
+	<link
+		rel="stylesheet"
+		href="https://unpkg.com/material-components-web@latest/dist/material-components-web.min.css"
+	/>
+	<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto+Mono" />
+	<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons" />
+
+	{%- seo -%} {% include styles.html %} {% include google-analytics.html %}
+</head>

data/_includes/hero.html

@@ -0,0 +1,16 @@
+<div class="hero mdc-theme--on-primary mdc-theme--primary-bg">
+	<div class="mdc-layout-grid grid-container">
+		<h1 class="mdc-typography--headline3">{{ site.title }}</h1>
+		<p class="mdc-typography--headline5">{{ site.description }}</p>
+
+		<p class="hero-actions">
+			<a
+				href="{{ 'getting-started' | relative_url }}"
+				class="mdc-button mdc-button--outlined mdc-theme--on-primary"
+			>
+				<span class="mdc-button__ripple"></span>
+				<span class="mdc-button__label">Get Started</span>
+			</a>
+		</p>
+	</div>
+</div>

data/_includes/license.html

@@ -0,0 +1,13 @@
+{% assign repo=site.github.public_repositories | where:"name", site.github.project_title %} {%
+assign start_year=repo[0].created_at | slice: 0, 4 %} {% assign end_year=repo[0].updated_at | slice:
+0, 4 %} {% if end_year == start_year %} {% assign year=start_year %}{% else %} {% assign
+year=start_year | append: ' - ' | append: end_year %}{% endif %}
+<span>
+	© {{ year }} under the terms of the
+	<a
+		href="{{ site.github.repository_url }}/blob/master/LICENSE"
+		class="mdc-theme--text-primary-on-background"
+	>
+		{{ site.github.license.name }}
+	</a>
+</span>

data/_includes/made-with-love.html

@@ -0,0 +1,9 @@
+<span>
+	Made with ❤️ by
+	<a
+		href="{{ site.author.url | default: site.github.owner.html_url }}"
+		class="mdc-theme--text-primary-on-background mdc-typography--headline6"
+	>
+		{{ site.author.name | default: site.github.owner.name }}
+	</a>
+</span>

data/_includes/styles.html

@@ -0,0 +1,6 @@
+<style type="text/css">
+	{% capture styles %}
+		@import 'main.scss';
+	{% endcapture %}
+	{{ styles | scssify }}
+</style>

data/_includes/top-bar.html

@@ -0,0 +1,34 @@
+<nav class="mdc-top-app-bar mdc-top-app-bar--fixed">
+	<div class="mdc-top-app-bar__row">
+		<section class="mdc-top-app-bar__section mdc-top-app-bar__section--align-start">
+			<a href="{{ '/' | relative_url }}" class="mdc-top-app-bar__title mdc-theme--on-primary">
+				{{ site.title }}
+			</a>
+		</section>
+		<section class="mdc-top-app-bar__section mdc-top-app-bar__section--align-end" role="toolbar">
+			{% for item in site.main_nav %}
+			<a
+				href="{{ site.github.url }}{{ item.url | escape | relative_url }}"
+				class="mdc-top-app-bar__action-item mdc-button"
+			>
+				{{ item.title | escape }}
+			</a>
+			{% endfor %} {% if site.twitter %}
+			<a
+				href="https://twitter.com/{{ site.twitter | escape }}"
+				class="mdc-top-app-bar__action-item mdc-icon-button"
+				aria-label="{{ site.title }} Twitter Link"
+			>
+				{% include twitter-icon.html %}
+			</a>
+			{% endif %}
+			<a
+				href="{{ site.github.repository_url }}"
+				class="mdc-top-app-bar__action-item mdc-icon-button"
+				aria-label="{{ site.title }} Github Repository Link"
+			>
+				{% include github-icon.html %}
+			</a>
+		</section>
+	</div>
+</nav>

data/_includes/twitter-icon.html

@@ -0,0 +1,10 @@
+<svg height="32" width="32" viewBox="0 0 400 400" aria-hidden="true">
+	<path
+		d="M400,200c0,110.5-89.5,200-200,200S0,310.5,0,200S89.5,0,200,0S400,89.5,400,200z M163.4,305.5
+	c88.7,0,137.2-73.5,137.2-137.2c0-2.1,0-4.2-0.1-6.2c9.4-6.8,17.6-15.3,24.1-25c-8.6,3.8-17.9,6.4-27.7,7.6
+	c10-6,17.6-15.4,21.2-26.7c-9.3,5.5-19.6,9.5-30.6,11.7c-8.8-9.4-21.3-15.2-35.2-15.2c-26.6,0-48.2,21.6-48.2,48.2
+	c0,3.8,0.4,7.5,1.3,11c-40.1-2-75.6-21.2-99.4-50.4c-4.1,7.1-6.5,15.4-6.5,24.2c0,16.7,8.5,31.5,21.5,40.1c-7.9-0.2-15.3-2.4-21.8-6
+	c0,0.2,0,0.4,0,0.6c0,23.4,16.6,42.8,38.7,47.3c-4,1.1-8.3,1.7-12.7,1.7c-3.1,0-6.1-0.3-9.1-0.9c6.1,19.2,23.9,33.1,45,33.5
+	c-16.5,12.9-37.3,20.6-59.9,20.6c-3.9,0-7.7-0.2-11.5-0.7C110.8,297.5,136.2,305.5,163.4,305.5"
+	/>
+</svg>

data/_layouts/compress.html

@@ -0,0 +1,10 @@
+---
+# Jekyll layout that compresses HTML
+# v3.1.0
+# http://jch.penibelst.de/
+# © 2014–2015 Anatol Broder
+# MIT License
+---
+
+{% capture _LINE_FEED %}
+{% endcapture %}{% if site.compress_html.ignore.envs contains jekyll.environment or site.compress_html.ignore.envs == "all" %}{{ content }}{% else %}{% capture _content %}{{ content }}{% endcapture %}{% assign _profile = site.compress_html.profile %}{% if site.compress_html.endings == "all" %}{% assign _endings = "html head body li dt dd optgroup option colgroup caption thead tbody tfoot tr td th" | split: " " %}{% else %}{% assign _endings = site.compress_html.endings %}{% endif %}{% for _element in _endings %}{% capture _end %}</{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _end %}{% endfor %}{% if _profile and _endings %}{% assign _profile_endings = _content | size | plus: 1 %}{% endif %}{% for _element in site.compress_html.startings %}{% capture _start %}<{{ _element }}>{% endcapture %}{% assign _content = _content | remove: _start %}{% endfor %}{% if _profile and site.compress_html.startings %}{% assign _profile_startings = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.comments == "all" %}{% assign _comments = "<!-- -->" | split: " " %}{% else %}{% assign _comments = site.compress_html.comments %}{% endif %}{% if _comments.size == 2 %}{% capture _comment_befores %}.{{ _content }}{% endcapture %}{% assign _comment_befores = _comment_befores | split: _comments.first %}{% for _comment_before in _comment_befores %}{% if forloop.first %}{% continue %}{% endif %}{% capture _comment_outside %}{% if _carry %}{{ _comments.first }}{% endif %}{{ _comment_before }}{% endcapture %}{% capture _comment %}{% unless _carry %}{{ _comments.first }}{% endunless %}{{ _comment_outside | split: _comments.last | first }}{% if _comment_outside contains _comments.last %}{{ _comments.last }}{% assign _carry = false %}{% else %}{% assign _carry = true %}{% endif %}{% endcapture %}{% assign _content = _content | remove_first: _comment %}{% endfor %}{% if _profile %}{% assign _profile_comments = _content | size | plus: 1 %}{% endif %}{% endif %}{% assign _pre_befores = _content | split: "<pre" %}{% assign _content = "" %}{% for _pre_before in _pre_befores %}{% assign _pres = _pre_before | split: "</pre>" %}{% assign _pres_after = "" %}{% if _pres.size != 0 %}{% if site.compress_html.blanklines %}{% assign _lines = _pres.last | split: _LINE_FEED %}{% capture _pres_after %}{% for _line in _lines %}{% assign _trimmed = _line | split: " " | join: " " %}{% if _trimmed != empty or forloop.last %}{% unless forloop.first %}{{ _LINE_FEED }}{% endunless %}{{ _line }}{% endif %}{% endfor %}{% endcapture %}{% else %}{% assign _pres_after = _pres.last | split: " " | join: " " %}{% endif %}{% endif %}{% capture _content %}{{ _content }}{% if _pre_before contains "</pre>" %}<pre{{ _pres.first }}</pre>{% endif %}{% unless _pre_before contains "</pre>" and _pres.size == 1 %}{{ _pres_after }}{% endunless %}{% endcapture %}{% endfor %}{% if _profile %}{% assign _profile_collapse = _content | size | plus: 1 %}{% endif %}{% if site.compress_html.clippings == "all" %}{% assign _clippings = "html head title base link meta style body article section nav aside h1 h2 h3 h4 h5 h6 hgroup header footer address p hr blockquote ol ul li dl dt dd figure figcaption main div table caption colgroup col tbody thead tfoot tr td th" | split: " " %}{% else %}{% assign _clippings = site.compress_html.clippings %}{% endif %}{% for _element in _clippings %}{% assign _edges = " <e;<e; </e>;</e>;</e> ;</e>" | replace: "e", _element | split: ";" %}{% assign _content = _content | replace: _edges[0], _edges[1] | replace: _edges[2], _edges[3] | replace: _edges[4], _edges[5] %}{% endfor %}{% if _profile and _clippings %}{% assign _profile_clippings = _content | size | plus: 1 %}{% endif %}{{ _content }}{% if _profile %} <table id="compress_html_profile_{{ site.time | date: "%Y%m%d" }}" class="compress_html_profile"> <thead> <tr> <td>Step <td>Bytes <tbody> <tr> <td>raw <td>{{ content | size }}{% if _profile_endings %} <tr> <td>endings <td>{{ _profile_endings }}{% endif %}{% if _profile_startings %} <tr> <td>startings <td>{{ _profile_startings }}{% endif %}{% if _profile_comments %} <tr> <td>comments <td>{{ _profile_comments }}{% endif %}{% if _profile_collapse %} <tr> <td>collapse <td>{{ _profile_collapse }}{% endif %}{% if _profile_clippings %} <tr> <td>clippings <td>{{ _profile_clippings }}{% endif %} </table>{% endif %}{% endif %}

data/_layouts/default.html

@@ -0,0 +1,12 @@
+---
+layout: compress
+---
+
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+	{%- include head.html -%}
+
+	<body class="mdc-typography mdc-typography--body1">
+		{{ content }} {% include footer.html %}
+	</body>
+</html>

data/_layouts/home.html

@@ -0,0 +1,12 @@
+---
+layout: default
+---
+
+<header>
+	{%- include top-bar.html -%}
+	<div class="mdc-top-app-bar--fixed-adjust">{%- include hero.html -%}</div>
+</header>
+
+<main class="mdc-layout-grid grid-container">
+	{%- include content.html -%}
+</main>

data/_layouts/page.html

@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<header>
+	{%- include top-bar.html -%}
+</header>
+
+<main class="main-content mdc-top-app-bar--fixed-adjust mdc-layout-grid grid-container">
+	<div class="mdc-layout-grid__inner">
+		<div
+			class="mdc-layout-grid__cell mdc-layout-grid__cell--span-4-phone mdc-layout-grid__cell--span-2-tablet mdc-layout-grid__cell--span-3-desktop"
+		>
+			<div class="position-sticky mdc-top-app-bar--fixed-adjust-relative">
+				{%- include content-table.html -%}
+			</div>
+		</div>
+		<div
+			class="mdc-layout-grid__cell mdc-layout-grid__cell--span-4-phone mdc-layout-grid__cell--span-6-tablet mdc-layout-grid__cell--span-9-desktop"
+		>
+			{%- include content.html -%}
+		</div>
+	</div>
+</main>

data/_sass/_code.scss

@@ -0,0 +1,24 @@
+code {
+  font-family: 'Roboto Mono', monospace;
+}
+
+pre {
+  overflow: scroll;
+  tab-size: 2;
+  hyphens: none;
+  white-space: pre;
+  word-spacing: normal;
+  word-break: normal;
+  word-wrap: normal;
+
+  padding: 1em;
+  background: #212121;
+  border-radius: 0.2em;
+  border: 1px solid #121212;
+  box-shadow: inset 0 1px 3px rgba(0, 0, 0, 0.3);
+
+  code {
+    color: #efefef;
+    text-shadow: 0px 1px 0px #000;
+  }
+}

data/_sass/_hero.scss

@@ -0,0 +1,11 @@
+.hero {
+  padding: 2em 0;
+}
+
+.hero .mdc-button--outlined {
+  border-color: currentColor;
+}
+
+.hero-actions {
+  margin: 6em 0 2em;
+}

data/_sass/_layout.scss

@@ -0,0 +1,12 @@
+.grid-container {
+  max-width: 1280px;
+}
+
+.position-sticky {
+  position: sticky;
+  top: 0;
+}
+
+.mdc-top-app-bar--fixed-adjust-relative {
+  top: 64px;
+}

data/_sass/_text.scss

@@ -0,0 +1,3 @@
+.text-center {
+  text-align: center;
+}

data/_sass/_theme.scss

@@ -0,0 +1,3 @@
+:root {
+  --mdc-theme-primary: #2196f3;
+}

data/_sass/main.scss

@@ -0,0 +1 @@
+@import 'theme', 'text', 'layout', 'hero', 'code';

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-material-docs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fernando Pasik
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-github-metadata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-seo-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- _includes/content-table.html
+- _includes/content.html
+- _includes/footer.html
+- _includes/github-icon.html
+- _includes/google-analytics.html
+- _includes/head.html
+- _includes/hero.html
+- _includes/license.html
+- _includes/made-with-love.html
+- _includes/styles.html
+- _includes/top-bar.html
+- _includes/twitter-icon.html
+- _layouts/compress.html
+- _layouts/default.html
+- _layouts/home.html
+- _layouts/page.html
+- _sass/_code.scss
+- _sass/_hero.scss
+- _sass/_layout.scss
+- _sass/_text.scss
+- _sass/_theme.scss
+- _sass/main.scss
+homepage: https://github.com/fernandopasik/jekyll-theme-material-docss
+licenses:
+- MIT
+metadata:
+  plugin_type: theme
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Jekyll theme built with material web components
+test_files: []