jekyll-yamt 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2050a638a54029f7a3794614f05645aa6c88a0fca0d47275fe5d34f4f06f7730
-  data.tar.gz: 5df8c73aba18572c48609c7b15b43726b62e0d930ea07ad02f0f69dfa2f3c40b
+  metadata.gz: 31c59a08dd085bd5e9daa15fd8ce1b9e2881e30f0e066fb513c2a18d3acbca4e
+  data.tar.gz: 26c6a6db2abd24c636d9da4028ecde3d89dbb42c6b582135774c6f68443fb019
 SHA512:
-  metadata.gz: b684852ae3d9c2b99e7fda634fdf82f45cd836ef842cec6ae4a45cc66a9572e182fbb604a48d759d57a79459c3c748ede8c97f97011989d578c379b43411936e
-  data.tar.gz: 4b43c711505cbbdfbca4d096612c5bab38160b5cf134c67626916146efb81f4e7f5614e6770c8ed9ba119e0de397c47631a53aca24284eb6fa59256f3747ffad
+  metadata.gz: 94723a3bc47259c4381e86ea6b24eaa1302bdbed008cbf911b126828160b8dc75efb7f2918e33f1af1e513ab1fe3f9140f33fe505cb4723d01ceac989eb44cb5
+  data.tar.gz: 23fccc79a12f7a0bcde9a9c7bcaca3bbc62e89779ce9dc4f03bc8b55be8e3e45151c03564ce3d762f7cd067e34cefcf86fffccc0d1ec45960b0bee7a08d8679a

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 PandaSekh
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2020 PandaSekh
+
+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

@@ -1,32 +1,58 @@
-# WORK IN PROGRESS! STILL NEED TO FIX MINOR THINGS AND TO WRITE THE DOCS
-
 # [YAMT - Yet Another Minimal Theme](https://yamt.netlify.app/)
-![status](http://img.shields.io/badge/Status-Unreleased-critical?style=plastict)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/249c3da6-7b23-4b57-915d-71934329e306/deploy-status)](https://yamt.netlify.app/)
 ![supports mathjax](https://img.shields.io/badge/Supports-MathJAX-blue)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/PandaSekh/Jekyll-YAMT/issues)
-
-[![Netlify Status](https://api.netlify.com/api/v1/badges/249c3da6-7b23-4b57-915d-71934329e306/deploy-status)](https://yamt.netlify.app/)
 ![GitHub forks](https://img.shields.io/github/forks/PandaSekh/Jekyll-YAMT?label=Fork%20it%21&style=social)
 ## [Live Demo](https://yamt.netlify.app/)
+
+![Homepage](https://raw.githubusercontent.com/PandaSekh/Jekyll-YAMT/master/assets/img/screenshots/Screenshot.png?raw=true)
+
 YAMT is a minimal [Jekyll](http://jekyllrb.com) theme focused on simplicity and ease-of-use. It has great modularity, allowing you to easily decide what you actually want on your website.
 
 ## Contents
 
 - [Features](#features)
+- [Screenshots](#screenshots)
 - [Installation](#installation)
-- [Usage](#usage)
 - [Customize](#options)
+  - [Basics](#Basics)
   - [Header](#header)
+  - [Home](#home)
   - [Post](#post)
+  - [Contact Form](#contact-form)
 - [Development](#development)
+- [Credits](#credits)
 - [License](#license)
 
 ## Features
 
+- Minimal and clean design.
+- Fully modular: activate and load only what you really need.
+- Works great on mobile and smaller screens.
+- Supports [Disqus](https://disqus.com/) comments activated only on button press, if you activate them.
+- [Google Analytics](https://www.google.com/analytics/) support.
+- [Open Graph](https://ogp.me/) and [Twitter Cards](https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started) support to better index the website content on search engines and social networks.
+- [MathJAX](https://www.mathjax.org/) and [LaTeX](https://www.latex-project.org/) optional support. Write beautiful math!
+- [RSS](https://github.com/jekyll/jekyll-feed) support.
+- Beautiful [Syntax Highlight](https://yamt.netlify.app/2020/05/19/special-formatting.html#syntax-highlight). Write some code and show it in a graceful way.
+
+## Screenshots
+
+Mobile:  
+![Mobile](https://raw.githubusercontent.com/PandaSekh/Jekyll-YAMT/master/assets/img/screenshots/Screenshot_mobile.png?raw=true)
+
+Code Highlight:  
+![Code](https://raw.githubusercontent.com/PandaSekh/Jekyll-YAMT/master/assets/img/screenshots/Screenshot_code_highlight.png)
+
+Minimal:  
+![Minimal](https://raw.githubusercontent.com/PandaSekh/Jekyll-YAMT/master/assets/img/screenshots/Screenshot_minimal.png?raw=true)
+
 ## Installation
+
 There are four way to use YAMT: Netlify (suggested, as this theme has a contact module built-in working only on Netlify), Github Pages, as a gem-based theme, by forking this repo or by copying all the files into your directory.
 
 ### Netlify
+
 1. [Fork this repo](https://github.com/PandaSekh/Jekyll-YAMT/generate). You can copy only master, set it to private or public and name it however you want.
 2. Go to [Netlify](https://app.netlify.com/), create a New site from Git, choose your repo or all repos, no difference. Back to Netlify, select the recently forked repo.
 3. Owner and branch are good to go. In build command write `bundle exec jekyll build` and publishing directory should be `_site/`.
@@ -34,32 +60,27 @@ There are four way to use YAMT: Netlify (suggested, as this theme has a contact
 
 ### Github Pages
 
-### Remote theme
-1. Have a gemfile with only the following content:
+Github Pages uses the [--safe flag](https://jekyllrb.com/docs/configuration/options/) to build jekyll websites, which disable custom plugins, caching to disk and ignore symbolic links. Because of that, I suggest you to use any other method. Netlify works great with a 5 minute config, so I suggest you use it.
 
-    ```ruby
-    source "https://rubygems.org"
+1. [Fork this repo](https://github.com/PandaSekh/Jekyll-YAMT/generate).
+2. Create a new branch in your repo and call it `gh-pages`.
+3. Publish your website and choose gh-pages as the target branch.
 
-    gem "github-pages", group: :jekyll_plugins
-    ```
-
-2. Run the following command:
+### Remote theme
 
-   ```bash
-   bundle
-   ```
+[Follow these instructions](https://help.github.com/en/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll).
 
 ### Gem-based theme 
 1. Add this line to your Jekyll site's `Gemfile`:
 
     ```ruby
-    gem "yamt"
+    gem "jekyll-yamt"
     ```
 
 2. And add this line to your Jekyll site's `_config.yml`:
 
     ```yaml
-    theme: yamt
+    theme: jekyll-yamt
     ```
 
 3. And then execute:
@@ -71,15 +92,43 @@ There are four way to use YAMT: Netlify (suggested, as this theme has a contact
 4. Or install it yourself as:
     
     ``` bash
-    $ gem install yamt
+    $ gem install jekyll-yamt
     ```
 
-## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+## Customize
+
+YAMT is easily customizable. If you don't need a functionality, just deactivate it in _data/settings.yml.
+Most of the customizable things are self-explanatory and found in the _data folder and in the _config.yml.
+
+### Basics
+
+Under the _data folder there are three files: pages, settings and social.
+In pages you can add other pages that will show up in the nav-
+In social you can add your socials that will show up in the nav. To add a social, find a suitable icon on [FontAwesome](https://fontawesome.com/) and add it's name in the name tag.
+Brand defines Font Awesome's font type (fas is solid, fab is brand).
+Out of the box this theme has support colors for a bunch of social. If your social isn't supported, just add the color in the header.css 
+
+In settings.yml you can activate or deactivate various functions of the theme, like analytics, disqus comments, related posts and so on.
+
+### Header
+In _data/settings.yml you can choose to hide or show the subtitle, the page navigation or the social icons.
+
+### Home
+In _data/settings.yml you can choose to hide or show the posts infos (date and read-time) and the featured image.
+
+### Post
+In _data/settings.yml you can choose to hide or show the post infos, categories, related posts and comments.
+Note that by removing categories the Categories Archives will no longer be reachable.
+
+### Contact Form
+YAMT has a built-in contact form builded using [Netlify](https://app.netlify.com/) free form functionality. To make it work you only need the line `data-netlify="true"` when declaring a form.  
+If you don't want to use Netlify, remove the line `data-netlify="true"`.
 
 ## Development
 
+[Contributions are welcomed and encouraged](https://github.com/PandaSekh/Jekyll-YAMT/issues).
+
 To set up your environment to develop this theme, run `bundle install`.
 
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
@@ -87,6 +136,10 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
 To add a custom directory to your theme-gem, please edit the regexp in `yamt.gemspec` accordingly.
 
-## License
+## Credits
+Inspired by [Lagrange by LeNPaul](https://lenpaul.github.io/Lagrange/).  
+Also great help from [this blog](https://blog.webjeda.com/), I've used this even before I created this theme.  
+Images from [Unsplash](https://unsplash.com/).
 
+## License
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/analytics.html

@@ -1,9 +1,9 @@
-<!-- Global site tag (gtag.js) - Google Analytics -->
-<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.analytics-id }}"></script>
-<script>
-  window.dataLayer = window.dataLayer || [];
-  function gtag(){dataLayer.push(arguments);}
-  gtag('js', new Date());
-
-  gtag('config', '{{ site.analytics-id }}');
-</script>
+<!-- Global site tag (gtag.js) - Google Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.analytics-id }}"></script>
+<script>
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.analytics-id }}');
+</script>

data/_includes/categories.html

@@ -1,13 +1,13 @@
-<div class="categories">
-    <span><p>Categories:</p>
-    {% if post %}
-      {% assign categories = post.categories %}
-    {% else %}
-      {% assign categories = page.categories %}
-    {% endif %}
-    {% for category in categories %}
-      <a href="{{site.url}}/categories/#{{category|slugize}}">{{category}}</a>
-      {% unless forloop.last %}&nbsp;{% endunless %}
-    {% endfor %}
-  </span>
+<div class="categories">
+    <span><p>Categories:</p>
+    {% if post %}
+      {% assign categories = post.categories %}
+    {% else %}
+      {% assign categories = page.categories %}
+    {% endif %}
+    {% for category in categories %}
+      <a href="{{site.url}}/categories/#{{category|slugize}}">{{category}}</a>
+      {% unless forloop.last %}&nbsp;{% endunless %}
+    {% endfor %}
+  </span>
   </div>

data/_includes/disqus.html

@@ -1,19 +1,19 @@
-<section class="disqus">
-    <p id="load-comments" onclick="loadDisqus()">Load Comments</p>
-    <div id="disqus_thread"></div>
-
-    <script id="loadDisqus" type="text/javascript">
-      var disqus_loaded = false;
-      var disqus_shortname = "{{ site.data.settings.disqus.disqus_shortname }}";
-      var disqus_identifier = "{{ page.url }}";
-      function loadDisqus() {
-        var e = document.createElement('script'); 
-        e.type = 'text/javascript'; 
-        e.async = true;
-        e.src = '//' + disqus_shortname + '.disqus.com/embed.js';
-        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(e);
-        document.getElementById("load-comments").style.display = "none";
-      };
-    </script>
-    <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments.</a></noscript>
+<section class="disqus">
+    <p id="load-comments" onclick="loadDisqus()">Load Comments</p>
+    <div id="disqus_thread"></div>
+
+    <script id="loadDisqus" type="text/javascript">
+      var disqus_loaded = false;
+      var disqus_shortname = "{{ site.data.settings.disqus.disqus_shortname }}";
+      var disqus_identifier = "{{ page.url }}";
+      function loadDisqus() {
+        var e = document.createElement('script'); 
+        e.type = 'text/javascript'; 
+        e.async = true;
+        e.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(e);
+        document.getElementById("load-comments").style.display = "none";
+      };
+    </script>
+    <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments.</a></noscript>
 </section>

data/_includes/footer.html

@@ -1,3 +1,3 @@
-<footer class= "footer">
-    <p>Copyright© {{site.author.name}} 2020. All right reserved. Theme designed by <a href="https://alessiofranceschi.me/">Alessio Franceschi</a>.</p>
+<footer class= "footer">
+    <p>Copyright© {{site.author.name}} 2020. All right reserved. Theme designed by <a href="https://alessiofranceschi.me/">Alessio Franceschi</a>.</p>
 </footer>

data/_includes/head.html

@@ -1,37 +1,37 @@
-    <html lang="en-US">
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-    <title>
-        {% if page.title == "Home" %}
-            {{ site.title }} | {{ site.description }}
-        {% else %}
-            {{ page.title }} | {{ site.title }}
-      {% endif %}
-    </title>
-    <meta name="description" content="
-    {% if page.description %}{{ page.description }}
-    {% else %}{{ site.description }}
-    {% endif %}">
-
-    <link rel="icon" href="/assets/favicon.ico" type="image/x-icon">
-    <link rel="shortcut icon" href="/assets/favicon.ico" type="image/x-icon">
-
-    <!-- CSS -->
-    <link rel="stylesheet" href="{{ "/assets/css/main.css" | prepend: site.baseurl | replace: '//', '/' }}">
-    <link rel="stylesheet" href="{{ "/assets/css/syntax.css" | prepend: site.baseurl | replace: '//', '/' }}">
-
-    <!-- Icons -->
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css">
-
-    <!-- Fonts -->
-    <link href="https://fonts.googleapis.com/css2?family=Montserrat:wght@700&family=PT+Serif&display=swap" rel="stylesheet">
-
-    <!-- SEO Plugin -->
-    {% seo %}
-
-    <!-- Google Analytics -->
-    {% if site.data.settings.analytics-id%}
-        {%- include analytics.html -%}
-    {% endif %}
+    <html lang="en-US">
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+    <title>
+        {% if page.title == "Home" %}
+            {{ site.title }} | {{ site.description }}
+        {% else %}
+            {{ page.title }} | {{ site.title }}
+      {% endif %}
+    </title>
+    <meta name="description" content="
+     {% if page.description %}{{ page.description }}
+     {% else %}{{ site.description }}
+    {% endif %}">
+
+    <link rel="icon" href="/assets/favicon.ico" type="image/x-icon">
+    <link rel="shortcut icon" href="/assets/favicon.ico" type="image/x-icon">
+
+    <!-- CSS -->
+    <link rel="stylesheet" href="{{ "/assets/css/main.css" | prepend: site.baseurl | replace: '//', '/' }}">
+    <link rel="stylesheet" href="{{ "/assets/css/syntax.css" | prepend: site.baseurl | replace: '//', '/' }}">
+
+    <!-- Icons -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css">
+
+    <!-- Fonts -->
+    <link href="https://fonts.googleapis.com/css2?family=Montserrat:wght@700&family=PT+Serif&display=swap" rel="stylesheet">
+
+    <!-- SEO Plugin -->
+    {% seo %}
+
+    <!-- Google Analytics -->
+    {% if site.data.settings.analytics-id%}
+        {%- include analytics.html -%}
+    {% endif %}
     <!-- End Google Analytics -->

data/_includes/header.html

@@ -1,16 +1,25 @@
-<header id="header">
-	<div id = site_title>
-		<a href="{{ site.url }}">
-			<h1>{{site.title}}</h1>
-		</a>
-	</div>
-
-	<div id="subheader">
-		<nav class="pages">
-			{%- include pages.html -%}
-		</nav>
-		<nav class="social">
-			{% include social.html %}
-		</nav>
-	</div>
+<header id="header">
+	<div id = site_title>
+		<a href="{{ site.url }}">
+			<h1>{{site.title}}</h1>
+		</a>
+		{% if site.data.settings.subtitle.active %}
+		<h2>
+			{{ site.data.settings.subtitle.text }}
+		</h2>
+		{% endif %}
+	</div>
+
+	<div id="subheader">
+		{% if site.data.settings.nav.pages.active %}
+		<nav class="pages">
+			{%- include pages.html -%}
+		</nav>
+		{% endif %}
+		{% if site.data.settings.nav.social.active %}
+		<nav class="social">
+			{% include social.html %}
+		</nav>
+		{% endif %}
+	</div>
 </header>

data/_includes/pages.html

@@ -1,3 +1,3 @@
-{% for item in site.data.pages.pages %}
-<a href="{{ site.url }}/{{ item.url }}">{{ item.name }}</a>
+{% for item in site.data.pages.pages %}
+<a href="{{ site.url }}/{{ item.url }}">{{ item.name }}</a>
 {% endfor %}

data/_includes/reading_time.html

@@ -1,21 +1,21 @@
-{% if post.layout != post %}
-  {% assign words = post.content | strip_html | number_of_words %}
-  {% if words < 180 %}
-    Less than 1 minute read
-  {% elsif words < 360 %}
-    1 minute read
-  {% else %}
-    {{ words | divided_by:180 }} minute read
-  {% endif %}
-{% endif %}
-
-{% if post.layout == post %}
-  {% assign words = content | number_of_words %}
-  {% if words < 180 %}
-    Less than 1 minute read
-  {% elsif words < 360 %}
-    1 minute read
-  {% else %}
-    {{ words | divided_by:180 }} minute read
-  {% endif %}
+{% if post.layout != post %}
+  {% assign words = post.content | strip_html | number_of_words %}
+  {% if words < 180 %}
+    Less than 1 minute read
+  {% elsif words < 360 %}
+    1 minute read
+  {% else %}
+    {{ words | divided_by:180 }} minute read
+  {% endif %}
+{% endif %}
+
+{% if post.layout == post %}
+  {% assign words = content | number_of_words %}
+  {% if words < 180 %}
+    Less than 1 minute read
+  {% elsif words < 360 %}
+    1 minute read
+  {% else %}
+    {{ words | divided_by:180 }} minute read
+  {% endif %}
 {% endif %}