jekyll-theme-material-docs 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460eac85a61b37d6b742b42bdf531315ee6e0b323997679f96d1a67a5f8b8ff9
-  data.tar.gz: a08825619b66c556c7c3c5948d64ba2da1b2e01769d20f9848401110f01d2078
+  metadata.gz: 19ed3903d4e6c7af7aa97590ea634d3f3a2da09eb107e10e2a1c1417b6aafb51
+  data.tar.gz: c69eebb0449be2cd37665e5210de802b6db04b236dfad65f4567dd604f680274
 SHA512:
-  metadata.gz: f917d8d506c21fa5075788603234f1a62317ddac58e0e9546f5908ea501f7f4b9ebb8675052e48c7d6b0812b8fb99244eec5680446a8e25bcd52d304379e06f0
-  data.tar.gz: 0d1b46d22ea2bb77de4aec0b3666e2d723f5dded4591f318a784c93d09467b1cef0e894ec77a2fd5aed4c18f605710008155ef830874a34f3a307a08118a8315
+  metadata.gz: 362b2f527c80b462a6c293d34ca7b96eeecd77a6a88e15e5bda9816362a3a40d5a9adb8e9148458ee782b9cc719b6b0fc989e8e8ea751a38f992092750e32d4f
+  data.tar.gz: 5dd6994916c9c2292cd0045dcf099345f18efdb66288b425d3c5eacd49420a3eb857405a378a94af17bd317286b6b3fdfe8d8737eb5b27fd4550878965931551

data/README.md

@@ -1,6 +1,11 @@
 # Material Docs
 
-Jekyll theme built with material web components
+[![Build Status][badge-ci]][url-ci]
+
+[badge-ci]: https://github.com/fernandopasik/jekyll-theme-material-docs/workflows/main/badge.svg
+[url-ci]: https://github.com/fernandopasik/jekyll-theme-material-docs/actions 'Build Status'
+
+Jekyll theme for documentation 📝 built with material web components
 
 ## Installation
 

data/_includes/footer.html

@@ -17,12 +17,8 @@
 			{% include github-icon.html %}
 		</a>
 	</p>
-	<p>
-		{% include made-with-love.html %}
-	</p>
+	<p>{% include made-with-love.html %}</p>
 	{%- if site.github.license -%}
-	<p>
-		{% include license.html %}
-	</p>
+	<p>{% include license.html %}</p>
 	{%- endif -%}
 </div>

data/_includes/head.html

@@ -2,13 +2,15 @@
 	<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="preconnect" href="https://fonts.gstatic.com" crossorigin />
+
 	<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 %}
+
+	<!-- custom head for scripts or styles -->
+	{% include custom-head.html %}
 </head>

data/_includes/hero.html

@@ -1,16 +1,28 @@
 <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>
+		<div class="mdc-layout-grid__inner">
+			<div
+				class="mdc-layout-grid__cell mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-6"
+			>
+				<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>
 
-		<p class="hero-actions">
-			<a
-				href="{{ 'getting-started' | relative_url }}"
-				class="mdc-button mdc-button--outlined mdc-theme--on-primary"
+			<div
+				class="mdc-layout-grid__cell mdc-layout-grid__cell--span-8-tablet mdc-layout-grid__cell--span-6 mdc-layout-grid__cell--align-middle"
 			>
-				<span class="mdc-button__ripple"></span>
-				<span class="mdc-button__label">Get Started</span>
-			</a>
-		</p>
+				{{ page.hero_example | markdownify }}
+			</div>
+		</div>
 	</div>
 </div>

data/_includes/top-bar.html

@@ -8,7 +8,7 @@
 		<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 }}"
+				href="{{ item.url | escape | relative_url }}"
 				class="mdc-top-app-bar__action-item mdc-button"
 			>
 				{{ item.title | escape }}

data/_layouts/home.html

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

data/_layouts/page.html

@@ -2,9 +2,7 @@
 layout: default
 ---
 
-<header>
-	{%- include top-bar.html -%}
-</header>
+<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">

data/_sass/_code.scss

@@ -3,7 +3,7 @@ code {
 }
 
 pre {
-  overflow: scroll;
+  overflow: auto;
   tab-size: 2;
   hyphens: none;
   white-space: pre;

data/_sass/_fonts.scss

@@ -0,0 +1,73 @@
+/* latin */
+@font-face {
+  font-family: 'Roboto';
+  font-style: normal;
+  font-weight: 300;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/roboto/v20/KFOlCnqEu92Fr1MmSU5fBBc4AMP6lQ.woff2)
+    format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F,
+    U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+
+/* latin */
+@font-face {
+  font-family: 'Roboto';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/roboto/v20/KFOmCnqEu92Fr1Mu4mxKKTU1Kg.woff2) format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F,
+    U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+
+/* latin */
+@font-face {
+  font-family: 'Roboto';
+  font-style: normal;
+  font-weight: 500;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/roboto/v20/KFOlCnqEu92Fr1MmEU9fBBc4AMP6lQ.woff2)
+    format('woff2');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F,
+    U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+
+/* latin */
+@font-face {
+  font-family: 'Roboto Mono';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/robotomono/v12/L0xuDF4xlVMF-BfR8bXMIhJHg45mwgGEFl0_3vq_ROW-AJi8SJQt.woff)
+    format('woff');
+  unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F,
+    U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+}
+
+/* fallback */
+@font-face {
+  font-family: 'Material Icons';
+  font-style: normal;
+  font-weight: 400;
+  font-display: swap;
+  src: url(https://fonts.gstatic.com/s/materialicons/v67/flUhRq6tzZclQEJ-Vdg-IuiaDsNcIhQ8tQ.woff2)
+    format('woff2');
+}
+
+.material-icons {
+  font-family: 'Material Icons', sans-serif;
+  font-feature-settings: 'liga';
+  font-weight: normal;
+  font-style: normal;
+  font-size: 24px;
+  line-height: 1;
+  letter-spacing: normal;
+  text-transform: none;
+  display: inline-block;
+  white-space: nowrap;
+  word-wrap: normal;
+  direction: ltr;
+  -webkit-font-feature-settings: 'liga';
+  -webkit-font-smoothing: antialiased;
+}

data/_sass/_normalize.scss

@@ -0,0 +1,351 @@
+/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
+
+/* Document
+   ========================================================================== */
+
+/**
+ * 1. Correct the line height in all browsers.
+ * 2. Prevent adjustments of font size after orientation changes in iOS.
+ */
+
+html {
+  line-height: 1.15; /* 1 */
+  -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/* Sections
+   ========================================================================== */
+
+/**
+ * Remove the margin in all browsers.
+ */
+
+body {
+  margin: 0;
+}
+
+/**
+ * Render the `main` element consistently in IE.
+ */
+
+main {
+  display: block;
+}
+
+/**
+ * Correct the font size and margin on `h1` elements within `section` and
+ * `article` contexts in Chrome, Firefox, and Safari.
+ */
+
+h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+/* Grouping content
+   ========================================================================== */
+
+/**
+ * 1. Add the correct box sizing in Firefox.
+ * 2. Show the overflow in Edge and IE.
+ */
+
+hr {
+  box-sizing: content-box; /* 1 */
+  height: 0; /* 1 */
+  overflow: visible; /* 2 */
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+pre {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/* Text-level semantics
+   ========================================================================== */
+
+/**
+ * Remove the gray background on active links in IE 10.
+ */
+
+a {
+  background-color: transparent;
+}
+
+/**
+ * 1. Remove the bottom border in Chrome 57-
+ * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
+ */
+
+abbr[title] {
+  border-bottom: none; /* 1 */
+  text-decoration: underline; /* 2 */
+  text-decoration: underline dotted; /* 2 */
+}
+
+/**
+ * Add the correct font weight in Chrome, Edge, and Safari.
+ */
+
+b,
+strong {
+  font-weight: bolder;
+}
+
+/**
+ * 1. Correct the inheritance and scaling of font size in all browsers.
+ * 2. Correct the odd `em` font sizing in all browsers.
+ */
+
+code,
+kbd,
+samp {
+  font-family: monospace, monospace; /* 1 */
+  font-size: 1em; /* 2 */
+}
+
+/**
+ * Add the correct font size in all browsers.
+ */
+
+small {
+  font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` elements from affecting the line height in
+ * all browsers.
+ */
+
+sub,
+sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+
+sub {
+  bottom: -0.25em;
+}
+
+sup {
+  top: -0.5em;
+}
+
+/* Embedded content
+   ========================================================================== */
+
+/**
+ * Remove the border on images inside links in IE 10.
+ */
+
+img {
+  border-style: none;
+}
+
+/* Forms
+   ========================================================================== */
+
+/**
+ * 1. Change the font styles in all browsers.
+ * 2. Remove the margin in Firefox and Safari.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  font-family: inherit; /* 1 */
+  font-size: 100%; /* 1 */
+  line-height: 1.15; /* 1 */
+  margin: 0; /* 2 */
+}
+
+/**
+ * Show the overflow in IE.
+ * 1. Show the overflow in Edge.
+ */
+
+button,
+input {
+  /* 1 */
+  overflow: visible;
+}
+
+/**
+ * Remove the inheritance of text transform in Edge, Firefox, and IE.
+ * 1. Remove the inheritance of text transform in Firefox.
+ */
+
+button,
+select {
+  /* 1 */
+  text-transform: none;
+}
+
+/**
+ * Correct the inability to style clickable types in iOS and Safari.
+ */
+
+button,
+[type='button'],
+[type='reset'],
+[type='submit'] {
+  -webkit-appearance: button;
+}
+
+/**
+ * Remove the inner border and padding in Firefox.
+ */
+
+button::-moz-focus-inner,
+[type='button']::-moz-focus-inner,
+[type='reset']::-moz-focus-inner,
+[type='submit']::-moz-focus-inner {
+  border-style: none;
+  padding: 0;
+}
+
+/**
+ * Restore the focus styles unset by the previous rule.
+ */
+
+button:-moz-focusring,
+[type='button']:-moz-focusring,
+[type='reset']:-moz-focusring,
+[type='submit']:-moz-focusring {
+  outline: 1px dotted ButtonText;
+}
+
+/**
+ * Correct the padding in Firefox.
+ */
+
+fieldset {
+  padding: 0.35em 0.75em 0.625em;
+}
+
+/**
+ * 1. Correct the text wrapping in Edge and IE.
+ * 2. Correct the color inheritance from `fieldset` elements in IE.
+ * 3. Remove the padding so developers are not caught out when they zero out
+ *    `fieldset` elements in all browsers.
+ */
+
+legend {
+  box-sizing: border-box; /* 1 */
+  color: inherit; /* 2 */
+  display: table; /* 1 */
+  max-width: 100%; /* 1 */
+  padding: 0; /* 3 */
+  white-space: normal; /* 1 */
+}
+
+/**
+ * Add the correct vertical alignment in Chrome, Firefox, and Opera.
+ */
+
+progress {
+  vertical-align: baseline;
+}
+
+/**
+ * Remove the default vertical scrollbar in IE 10+.
+ */
+
+textarea {
+  overflow: auto;
+}
+
+/**
+ * 1. Add the correct box sizing in IE 10.
+ * 2. Remove the padding in IE 10.
+ */
+
+[type='checkbox'],
+[type='radio'] {
+  box-sizing: border-box; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Correct the cursor style of increment and decrement buttons in Chrome.
+ */
+
+[type='number']::-webkit-inner-spin-button,
+[type='number']::-webkit-outer-spin-button {
+  height: auto;
+}
+
+/**
+ * 1. Correct the odd appearance in Chrome and Safari.
+ * 2. Correct the outline style in Safari.
+ */
+
+[type='search'] {
+  -webkit-appearance: textfield; /* 1 */
+  outline-offset: -2px; /* 2 */
+}
+
+/**
+ * Remove the inner padding in Chrome and Safari on macOS.
+ */
+
+[type='search']::-webkit-search-decoration {
+  -webkit-appearance: none;
+}
+
+/**
+ * 1. Correct the inability to style clickable types in iOS and Safari.
+ * 2. Change font properties to `inherit` in Safari.
+ */
+
+::-webkit-file-upload-button {
+  -webkit-appearance: button; /* 1 */
+  font: inherit; /* 2 */
+}
+
+/* Interactive
+   ========================================================================== */
+
+/*
+ * Add the correct display in Edge, IE 10+, and Firefox.
+ */
+
+details {
+  display: block;
+}
+
+/*
+ * Add the correct display in all browsers.
+ */
+
+summary {
+  display: list-item;
+}
+
+/* Misc
+   ========================================================================== */
+
+/**
+ * Add the correct display in IE 10+.
+ */
+
+template {
+  display: none;
+}
+
+/**
+ * Add the correct display in IE 10.
+ */
+
+[hidden] {
+  display: none;
+}

data/_sass/main.scss

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-material-docs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - Fernando Pasik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -62,6 +62,7 @@ files:
 - README.md
 - _includes/content-table.html
 - _includes/content.html
+- _includes/custom-head.html
 - _includes/footer.html
 - _includes/github-icon.html
 - _includes/google-analytics.html
@@ -77,8 +78,10 @@ files:
 - _layouts/home.html
 - _layouts/page.html
 - _sass/_code.scss
+- _sass/_fonts.scss
 - _sass/_hero.scss
 - _sass/_layout.scss
+- _sass/_normalize.scss
 - _sass/_text.scss
 - _sass/_theme.scss
 - _sass/main.scss
@@ -102,8 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Jekyll theme built with material web components
+summary: "Jekyll theme for documentation \U0001F4DD built with material web components"
 test_files: []