jekyll-theme-superb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c72135f444f043807d0731bf16585c01c39f7095085dc7d9e3f49d382fc87f47
+  data.tar.gz: 4bfc980ac998e2c37648a742c4879b05266e1a38776dfe0489639781a88e42f0
+SHA512:
+  metadata.gz: 04ccace13d1691ee940516c7d54c95e1ac8ab6ddab52a61160b891d0c7b6b7ac7576a7ca0e5280e760eec0687f2a874e4e1f20145490c382c013a838386bc310
+  data.tar.gz: ba2ed680d8fed84d0f1f550d81ec798a7a5360541889e60b79fbc44b575d24523b0471f80185393ac86ef4317efb03cebf38b118f3a1d7f4bb0b29a5575d2cce

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ivanka Todorova
+
+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,61 @@
+# jekyll-theme-superb
+
+This is a simple Jekyll theme that uses [tailwindCSS's-based ui-kit](https://github.com/simplysuperb-dev/ui-kit) of simply**superb**. My blog uses it currently, so you can see it live at: https://blog.simplysuperb.app/. Additionally, here's a screenshot*:
+
+![screenshot of the theme](./screenshot.png)
+
+  _\* Article titles were copied from [dev.to](dev.to)'s homepage at the time of designing of this template._
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-superb"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-superb
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-superb
+
+## Usage
+
+Theme has a `post` layout used for displaying a single post, an `index` layout used for displaying all posts and a page layout that differs slightly from the `post` layout.
+
+## Configuration
+
+@TODO: Document all available config options
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/simplysuperb-dev/jekyll-theme-superb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+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 `npm run jekyll:dev` 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.
+
+Additionally, the theme is based on tailwindCSS, so postcss is required to modify existing styles:
+
+    $ npm install
+    $ npm run css:dev
+
+
+
+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 `jekyll-theme-superb.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_config.yml

@@ -0,0 +1,9 @@
+title: ssb. # title of the blog used in <title> & as a logo
+subtitle: /blog # subtitle of the blog used in <title> & next to name 
+sass:
+  sass_dir: _sass
+  style: compact
+plugins:
+  - jekyll-postcss
+  - jekyll-feed
+  - jekyll-seo-tag

data/_includes/custom-head.html

@@ -0,0 +1,3 @@
+{% comment %}
+  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons, meta tags, etc.
+{% endcomment %}

data/_includes/footer.html

@@ -0,0 +1,14 @@
+<div class="border-t border-porcelain py-4 text-caption">
+    <div class="text-center desktop:flex desktop:justify-between space-y-2">
+        <p>
+            {{ site.time | date: '%Y' }} (C) All rights reserved.
+        </p>
+        <p>
+            <a href="https://github.com/simplysuperb-dev/jekyll-theme-superb" target="_blank"
+                class="inline-block text-green font-bold">superb.</a> theme
+            made with ❤️ by
+            <a href="https://itodorova.dev/" target="_blank"
+                class="py-1 px-2 bg-yellow inline-block text-white">itodorova.dev</a>
+        </p>
+    </div>
+</div>

data/_includes/google-analytics.html

@@ -0,0 +1,9 @@
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+  window['ga-disable-{{ site.google_analytics }}'] = window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1";
+  window.dataLayer = window.dataLayer || [];
+  function gtag(){window.dataLayer.push(arguments);}
+  gtag('js', new Date());
+
+  gtag('config', '{{ site.google_analytics }}');
+</script>

data/_includes/head.html

@@ -0,0 +1,14 @@
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {%- seo -%}
+    <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+    {%- feed_meta -%}
+    {%- if jekyll.environment == 'production' and site.google_analytics -%}
+      {%- include google-analytics.html -%}
+    {%- endif -%}
+  
+    {%- include custom-head.html -%}
+    <script src="{{'/assets/js/main.js'}}"></script>
+  </head>

data/_includes/header.html

@@ -0,0 +1,67 @@
+<header class="bg-white border-b border-porcelain desktop:border-none">
+    <nav>
+        <div class="flex justify-between px-4 desktop:px-0">
+            <div>
+                <a href="{{ '/' | relative_url }}" class="flex items-center py-2 desktop:py-4 text-h4 desktop:text-h3">
+                    {% assign restOfTitleLen = site.title.size | minus: 3 %}
+                    <span class="text-graphite">{{ site.title | escape | slice: 0, restOfTitleLen }}</span>
+                    <span class="text-green">{{ site.title | escape | slice: -3, 2 }}</span>
+                    <span class="text-graphite">{{ site.title | escape | slice: -1, 1 }}</span>
+                    {% if site.subtitle %}
+                    <span class="text-grey/50 hidden desktop:inline text-h5 ml-4">
+                        {{ site.subtitle }}
+                    </span>
+                    {% endif %}
+                </a>
+            </div>
+            <div class="hidden desktop:flex items-center space-x-5">
+                <a href="{{ '/' | relative_url }}" {% if page.url=='/' %}
+                    class="text-green border-green border-b-2 transition duration-300" {% else %}
+                    class="text-graphite border-b-2 border-white hover:border-graphite hover:border-b-2 transition duration-300"
+                    {% endif %}>posts</a>
+                {% for my_page in site.pages %}
+                {% if my_page.title %}
+                <a href="{{ my_page.url | relative_url }}" {% if my_page.url==page.url %}
+                    class="text-green border-green border-b-2 transition duration-300" {% else %}
+                    class="text-graphite border-b-2 border-white hover:border-graphite hover:border-b-2 transition duration-300"
+                    {% endif %}>
+                    {{ my_page.title | escape }}
+                </a>
+                {% endif %}
+                {% endfor %}
+            </div>
+            <div class="desktop:hidden flex items-center">
+                <button class="outline-none mobile-menu-button">
+                    <svg class="w-6 h-6 text-graphite hover:text-green" x-show="!showMenu" fill="none"
+                        stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24"
+                        stroke="currentColor">
+                        <path d="M4 6h16M4 12h16M4 18h16"></path>
+                    </svg>
+                </button>
+            </div>
+        </div>
+        <!-- mobile menu -->
+        <div class="hidden mobile-menu border-porcelain border-t">
+            <ul class="max-w-max flex space-x-5  bg-white p-4">
+                <li>
+                    <a href="{{ '/' | relative_url }}" {% if page.url=='/' %}
+                        class="text-green border-green border-b-2 transition duration-300" {% else %}
+                        class="text-graphite border-b-2 border-white hover:border-graphite hover:border-b-2 transition duration-300"
+                        {% endif %}>posts</a>
+                </li>
+                {% for my_page in site.pages %}
+                {% if my_page.title %}
+                <li>
+                    <a href="{{ my_page.url | relative_url }}" {% if my_page.url==page.url %}
+                        class="text-green border-green border-b-2 transition duration-300" {% else %}
+                        class="text-graphite border-b-2 border-white hover:border-graphite hover:border-b-2 transition duration-300"
+                        {% endif %}>
+                        {{ my_page.title | escape }}
+                    </a>
+                </li>
+                {% endif %}
+                {% endfor %}
+            </ul>
+        </div>
+    </nav>
+</header>

data/_layouts/default.html

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: 'en' }}">
+
+{%- include head.html -%}
+
+<body class="font-merriweather">
+    <div class="container mx-auto">
+        
+    {%- include header.html -%}
+
+    {{content}}
+
+    {%- include footer.html -%}
+    </div>
+</body>
+
+</html>

data/_layouts/home.html

@@ -0,0 +1,26 @@
+---
+layout: default
+---
+
+{% assign posts = site.posts %}
+
+{%- if posts.size > 0 -%}
+<ul class="mb-5 px-2 desktop:px-0">
+  {%- for post in posts -%}
+  <li class="mb-10">
+    <div class="my-2">
+      <span class="text-grey/50">0644</span>
+      <span class="text-graphite mx-4">{{ post.author }}</span>
+      <span class="text-graphite">{{ post.date | date: "%-d %b '%y" }}</span>
+    </div>
+    <a class="post-link" href="{{ post.url | relative_url }}">
+      <span class="text-grey/50 text-subtitle">./</span>
+      <span class="text-graphite text-h5 underline">{{ post.title | escape }}</span>
+      <span class="text-grey/50 text-subtitle">.txt</span>
+    </a>
+  </li>
+  {%- endfor -%}
+</ul>
+{%- else -%}
+<h3 class="text-grey text-h5 desktop:text-h3 py-10 desktop:px-0 px-4">No posts available.</h3>
+{% endif %}

data/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}

data/_layouts/post.html

@@ -0,0 +1,13 @@
+---
+layout: default
+---
+
+<div class="prose max-w-fit py-4">
+    <div>
+      <span class="text-grey/50">0644</span>
+      <span class="text-graphite mx-4">{{ page.author }}</span>
+      <span class="text-graphite">{{ page.date | date: "%-d %b '%y" }}</span>
+    </div>
+    <h2 class="mb-6 mt-0">{{page.title}}</h2>
+    {{ content }}
+</div>

data/_sass/theme.scss

@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;

data/assets/js/main.js

@@ -0,0 +1,9 @@
+window.addEventListener('load', () => {
+    // Mobile navigation
+    const btn = document.querySelector("button.mobile-menu-button");
+    const menu = document.querySelector(".mobile-menu");
+
+    btn.addEventListener("click", () => {
+        menu.classList.toggle("hidden");
+    });
+});

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-superb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivanka Todorova
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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:
+- fakeheal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- _config.yml
+- _includes/custom-head.html
+- _includes/footer.html
+- _includes/google-analytics.html
+- _includes/head.html
+- _includes/header.html
+- _layouts/default.html
+- _layouts/home.html
+- _layouts/page.html
+- _layouts/post.html
+- _sass/theme.scss
+- assets/js/main.js
+homepage: https://github.com/simplysuperb-dev/jekyll-theme-superb
+licenses:
+- MIT
+metadata: {}
+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.0.3.1
+signing_key:
+specification_version: 4
+summary: Simple type driven theme suitable for developers.
+test_files: []