redeyed-jekyll-theme 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9afbd55c25c819aa7e10d7d4e73ad730d5b4b47a3a999fee411cf2374e5cddaa
-  data.tar.gz: d61a8ce636758580c883579bb0787f2e10214febdb46d60d884a92efe6783e73
+  metadata.gz: e779e1aca59fbaebfdbe28b6ae59a37c67dbc365c9e9c87fe4f890e7dd96a352
+  data.tar.gz: 8f918e8e392a1e818e1c51c15ff5bfd0f19f689acc2e72dfbdfea28ea338b166
 SHA512:
-  metadata.gz: a9cc4a9bf735e1f3e78f4405ecacafc1633fe43a597b8f8b233c09823c785e35ac11b515abfeced2a28e0a54b80254ba25ba555b57889d052ee6442022d5497d
-  data.tar.gz: 5fed1ca5382ee8c842ce1029d233ec5412b2ec00baef8b6caec44629767aea5f6371ec5f6b84fc02e20f86038382983272d6974bcefa0054b7cbeba573e99237
+  metadata.gz: 4fa1dc0e9e7a7e1ca159a5fb93890e9198bdb44a0dab0da09d0cbfee8f3a8f490d9e0c5effd9f03d1d31e043bab786d6bb76640ee4cb1fc1c7b082298d91df64
+  data.tar.gz: 4d9a3635130fb7b319e16cf9e4e6a3f2dfef01e019135bbe15dd20033327448a59355737b826c22bb81ba0e71be0eb8a3fc9be1c4307a5acb217714f56ea0432

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Ragdata
+Copyright © 2022 ~ Ragdata & RedEyed-RPG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,54 +1,191 @@
-[![Gem Version](https://badge.fury.io/rb/redeyed-jekyll-theme.svg)](https://badge.fury.io/rb/redeyed-jekyll-theme)
+<div align="center">
 
-# redeyed-jekyll-theme
+<img src="https://aever.net/images/brand/banner/RedEyedRPG-960-Red.png" alt="RedEyed RPG" />
 
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+# redeyed-jekyll-theme<br />v0.1.5
 
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+<em>A versatile, responsive, and powerful Jekyll Theme designed for a gaming site</em>
 
-TODO: Delete this and the text above, and describe your gem
+[**https://www.redeyed-rpg.com**](https://www.redeyed-rpg.com)
 
+#### [Contributing](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/wiki/Contributor's-Guide) &middot; [Community Guidelines](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/wiki/Contributor-Covenant-&-Code-of-Conduct) &middot; [Submit an Issue](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/issues/new/choose) &middot; [Ask a Question](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/discussions)
+
+<a href="https://patreon.com/ragdata"><img src="assets/img/social/patreon.svg" height="24" width="24"></a> &nbsp;
+<a href="https://twitter.com/RedeyedRPG"><img src="assets/img/social/twitter.svg" height="24" width="24"></a> &nbsp;
+<a href="https://reddit.com/r/redeyed"><img src="assets/img/social/reddit.svg" height="24" width="24" alt="RedEyed-RPG Subreddit"></a> &nbsp;
+<a href="https://facebook.com/RedeyedRPG"><img src="assets/img/social/facebook.svg" height="24" width="24"></a> &nbsp;
+<a href="https://redeyed-rpg.tumblr.com"><img src="assets/img/social/tumblr.svg" height="24" width="24"></a> &nbsp;
+<a href="https://github.com/redeyed-rpg"><img src="assets/img/social/github.svg" height="24" width="24"></a> &nbsp;
+<a href="https://www.guilded.gg/i/27dYX5Xk"><img src="assets/img/social/guilded.svg" height="24" width="24"></a>
+
+
+[//]: # ([![Gem Version]&#40;https://badge.fury.io/rb/redeyed-jekyll-theme.svg&#41;]&#40;https://badge.fury.io/rb/redeyed-jekyll-theme&#41; &nbsp;)
+[//]: # ([![GitHub version]&#40;https://badge.fury.io/gh/RedEyed-RPG%2Fredeyed-jekyll-theme.svg&#41;]&#40;https://badge.fury.io/rb/redeyed-jekyll-theme&#41; &nbsp;)
+[![GitHub package.json version](https://img.shields.io/github/package-json/v/RedEyed-RPG/redeyed-jekyll-theme)]() &nbsp;
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/RedEyed-RPG/redeyed-jekyll-theme/CI)](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/actions/workflows/ci.yml) &nbsp;
+[![GitHub license](https://img.shields.io/github/license/RedEyed-RPG/redeyed-jekyll-theme.svg)](https://github.com/RedEyed-RPG/redeyed-jekyll-theme/blob/master/LICENSE) &nbsp;
+[![Repo Code Weight](https://img.shields.io/github/languages/code-size/RedEyed-RPG/redeyed-jekyll-theme)](https://github.com/RedEyed-RPG/redeyed-jekyll-theme)
+<br/><br/>
+[![Support Me via Patreon](https://img.shields.io/badge/Patreon-Sponsor-%23FF424D?logo=patreon)](https://patreon.com/ragdata) &nbsp;
+[![Support Me via Liberapay](https://img.shields.io/badge/liberapay-Support-yellow?logo=liberapay)](https://liberapay.com/Ragdata/) &nbsp;
+[![Support Me via GitHub](https://img.shields.io/badge/Github-Sponsor-blue?logo=Github)](https://github.com/sponsors/Ragdata) &nbsp;
+[![Support Me via Ko-fi](https://img.shields.io/badge/Ko--fi-Support-%23FF5E5B?logo=ko-fi)](https://ko-fi.com/ragdata)
+<br/><br/>
+[![](https://img.shields.io/badge/Guilded-Support%20Server%20Online-%23F5C400?logo=guilded)](https://www.guilded.gg/i/27dYX5Xk)
+
+</div>
+
+## Features
+
+- Localized Layout
+- Dark/Light Theme Mode
+- Pinned Posts
+- Hierarchical Categories
+- Last Modified Date for Posts
+- Table of Contents
+- Auto-Generated Related Posts
+- Syntax Highlighting
+- Mathematical Expressions
+- Disqus/Utterances/Giscus/Gitment Comments
+- Site Search
+- Atom Feeds
+- Google Analytics
+- SEO & Performance Optimisation
+
+## Introduction
+
+<div align="center"><img src="assets/img/banner.svg" widtH="100%"></div>
+
+If you want to use the theme just as it is on your own website, you have two options:
+
+- To install this theme as part of a brand-new Jekyll site, you want the [RedEyed Jumpstarter]().
+- To add this theme to your existing website, see [this documentation]().
 
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
 
-```ruby
+```console
 gem "redeyed-jekyll-theme"
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
 
-```yaml
+```console
 theme: redeyed-jekyll-theme
 ```
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install redeyed-jekyll-theme
+```console
+$ gem install redeyed-jekyll-theme
+```
+
+## 📚 Developer's Quick Start
+
+Before you start, please ensure that you've followed the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`.  You also need to have the following packages installed:
+
+- Git
+- Node.js & npm (I recommend [NVM](https://github.com/nvm-sh/nvm) regardless of your platform)
+
+### 📘 1. Fork the Project
+
+The first step you have already hopefully completed before getting to this part of the instructions - you need to fork the project from Github using your favourite tools or the Github website itself.
+
+### 📘 2. Rename & Modify the Gemspec
+
+The next thing you'll want to do is rename the `redeyed-jekyll-theme.gemspec` file to reflect the name of your own project.  Then, open that file and take care of the following details:
+
+- spec.name
+- spec.version
+- spec.authors
+- spec.email
+- spec.summary
+- spec.homepage
+- spec.license
+- spec.metadata
+
+### 📘 3. Install standard-version
+
+(Yes, I know it's deprecated - I'll change this as soon as I find a suitable replacement)
+
+Install `standard-version` as a global `bin`:
 
-## Usage
+```console
+$ npm i -g standard-version
+```
+
+### 📘 4. Install Commitlint & Husky
+
+> If you don't need to do things your own way, Commitlint and Husky can be installed using the script I've included with this package:
+> ```console
+> $ bash bin/install-commitlint
+> ```
+> Otherwise, follow each step below and make your changes as necessary
+
+Install `commitlint` & `husky`
+
+```console
+$ npm i --save-dev --location=global @commitlint/cli @commitlint/config-conventional husky
+```
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+Configure `commitlint` to use conventional config:
 
-## Contributing
+```console
+$ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > ..commitlintrc.js
+```
+
+And then enable `husky`:
+
+```console
+$ husky install
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
+Add a husky commit hook:
 
-## Development
+```shell
+cat <<EEE > .husky/commit-msg
+#!/usr/bin/env bash
+. "\$(dirname "\$0")/_/husky.sh"
+npx --no -- commitlint --edit "\${1}"
+EEE
+```
 
-To set up your environment to develop this theme, run `bundle install`.
+Make the hook executable:
 
-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.
+```console
+$ chmod a+x .husky/commit-msg
+```
+
+Make sure you check out the [Contributor's Guide - Appendices](.github/CONTRIBUTING.md#appendix-a-commitlint-commit-types) for tips on how to use commitlint, why it's useful, and examples of how to structure your own commit messages to make the best use of the package.
+
+### 📘 5. Install Dependencies
+
+Install Jekyll dependencies:
+
+```console
+$ bundle install
+```
+
+### 📘 6. Start Local Server
+
+Then, start your local server in watch mode:
+
+```console
+$ bundle exex jekyll serve --watch
+```
+
+Now, open your browser to http://localhost:4000 and make your changes
 
 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 `redeyed-jekyll-theme.gemspec` accordingly.
 
-## License
+## 📋 License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/_config.yml

@@ -30,15 +30,17 @@ tagline             : "Content, Maps, & Software for your favourite TTRPGs"
 description         : "RedEyed RPG produces content and software for a variety of Table Top Role Playing Game systems"
 logo                : "/assets/img/logo/597x597-RPG-R-Circle-320.png"
 url                 : "https://www.redeyed-rpg.com"
-baseurl             : ""
 theme               : "redeyed-jekyll-theme"
-repo                : "https://github.com/RedEyed-RPG/redeyed-jekyll-theme"
 email               : "ragdata@redeyed-rpg.com"
 date_format         : "%-d %B %Y"
 encoding            : utf-8
 lang                : en-AU
 locale              : en_AU
 css_inline          : false
+
+# the subpath for your site eg: /blog
+baseurl                 : ""
+
 # google_analytics    :
 # google_site_verification:                   # jekyll-seo-tag
 # google_analytics_anonymize_ip:
@@ -50,31 +52,21 @@ toc: true                                   # table of contents - global switch
 theme_mode: dark                            # custom config option: [light|dark|brew]
 copyright: "Copyright (c) 2022 ~ {author} & RedEyed-RPG ~ Some Rights Reserved"
 
+# Change to your timezone » http://www.timezoneconverter.com/cgi-bin/findzone/findzone
+timezone: "Australia/Brisbane"
+
+# additional parameters for datetime localization (optional) » https://github.com/iamkun/jayjs/tree/dev/src/locale
+prefer_datetime_locale: en-au
+
+# the url of YOUR site repo
+repo: "https://github.com/RedEyed-RPG/redeyed-jekyll-theme"
+
 ####################################################################
 # 2. GEM SETTINGS
 ####################################################################
 feed:                                       # jekyll-feed
     path: /blog/feed.atom                   # jekyll-feed > feed path
 
-
-
-#pagination:                                 # jekyll-paginate-v2
-#    enabled: false                           # jekyll-paginate-v2 > enabled
-#    debug: false                            # jekyll-paginate-v2 > debug mode
-#    collection: posts                       # jekyll-paginate-v2 > default collection to paginate
-#    per_page: 10                            # jekyll-paginate-v2 > results per page
-#    permalink: 'page/:num:output_ext'       # jekyll-paginate-v2 > permalink format
-#    title: ':title - page :num'             # jekyll-paginate-v2 > title format
-#    limit: 0                                # jekyll-paginate-v2 > limit
-#    sort_field: date                        # jekyll-paginate-v2 > sort field
-#    sort_reverse: true                      # jekyll-paginate-v2 > reverse sort option
-#    category: posts                         # jekyll-paginate-v2 > category
-#    trail:                                  # jekyll-paginate-v2 > page link trail
-#        before: 2                           # jekyll-paginate-v2 > number of page links to show before current
-#        after: 2                            # jekyll-paginate-v2 > number of page links to show after current
-#    extension: html                         # jekyll-paginate-v2 > default page extension
-#    indexpage: index                        # jekyll-paginate-v2 > name of index page
-
 jekyll-mentions: https://twitter.com        # jekyll-mentions > service used when @replying
 
 twitter:                                    # jekyll-seo-tag > twitter properties
@@ -136,7 +128,6 @@ sass:
     sass_dir: ../_sass
 permalink: date                             # permalink style (YYYY/MM/DD/page-name)
 excerpt_separator: <!-- more -->            # marks end of excerpt in posts
-timezone: Australia/Brisbane                # timezone for blog and posts
 paginate: 10                                # paginate - # of items per page
 paginate_path: /page:num                    # paginate - default page slug for pages
 
@@ -217,8 +208,7 @@ plugins:
     - jekyll-paginate
     - jekyll-spaceship
     - jekyll-pluralize
-#    - jekyll-paginate-v2
-#    - jekyll-include-cache
+    - jekyll-contentblocks
     - jekyll-redirect-from
     - jekyll-email-protect
     - jekyll-tagging-related_posts
@@ -232,12 +222,12 @@ plugins:
 # BUILD SETTINGS
 ####################################################################
 source: src
-#destination: _site
-#collections_dir: _data
-#data_dir: _data
-#plugins_dir: _plugins
-#layouts_dir: _layouts
-#includes_dir: _includes
+# destination: _site
+# collections_dir: _data
+# data_dir: _data
+# plugins_dir: _plugins
+# layouts_dir: _layouts
+# includes_dir: _includes
 
 ####################################################################
 # READ CONFIG
@@ -289,6 +279,7 @@ assets:
     self-host:
         enabled: false
         env: development
+
 ####################################################################
 # OUTPUT
 ####################################################################
@@ -324,12 +315,11 @@ exclude:
     - '*.gem'
     - '*.gemspec'
     - .github
+    - bin
+    - gulpfile.js
     - README.md
+    - CHANGELOG.md
     - LICENSE
-    - Gemfile
-    - Gemfile.lock
-    - gulpfile.js
     - package*.json
     - node_modules
     - vendor
-    - bin

data/_data/assets/cross-origin.yml

@@ -11,7 +11,7 @@ cdns:
 
 # FONTS
 
-webfonts: https://fonts.googleapis.com/css2?family=Cormorant+Unicase:wght@300;400;500;600;700&family=Cormorant+Infant:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&family=Xanh+Mono:ital@0;1&display=swap
+webfonts: https://fonts.googleapis.com/css2?family=Cormorant+SC:wght@400;700&family=Cormorant+Upright:wght@400;700&family=Cormorant:ital,wght@0,400;0,700;1,400;1,700&family=Cormorant+Garamond:ital,wght@0,400;0,700;1,400;1,700&family=Cormorant+Unicase:wght@300;400;500;600;700&family=Cormorant+Infant:ital,wght@0,300;0,400;0,500;0,600;0,700;1,300;1,400;1,500;1,600;1,700&family=Xanh+Mono:ital@0;1&family=Alegreya+SC:ital,wght@0,400;0,700;1,400;1,700&family=Alegreya+Sans+SC:ital,wght@0,100;0,400;0,700;1,100;1,400;1,700&family=Alegreya+Sans:ital,wght@0,100;0,400;0,700;1,100;1,400;1,700&family=Alegreya:ital,wght@0,400;0,700;1,400;1,700&display=swap
 
 # LIBRARIES
 

data/_includes/{elements → components}/javascript.html

@@ -15,7 +15,7 @@
           | append: ',' | append: site.data.assets[origin].lozad.js
           | append: ',' | append: site.data.assets[origin].clipboard.js
     %}
-    {% include elements/jsdelivr-combine.html urls=_urls %}
+    {% include functions/js-combine.html urls=_urls %}
 {% endif %}
 
 {% if page.layout == 'home'
@@ -34,7 +34,7 @@
           | append: ',' | append: site.data.assets[origin].dayjs.js.relativeTime
           | append: ',' | append: site.data.assets[origin].dayjs.js.localizedFormat
     %}
-    {% include elements/jsdelivr-combine.html urls=_urls %}
+    {% include functions/js-combine.html urls=_urls %}
 {% endif %}
 
 {% if page.layout == 'home'
@@ -53,37 +53,14 @@
 {% capture script %}/assets/js/dist/{{ type }}.min.js{% endcapture %}
 <script defer src="{{ script | relative_url }}"></script>
 
-{% if page.math %}
-<!-- MathJax -->
-<script>
-  /* see: <https://docs.mathjax.org/en/latest/options/input/tex.html#tex-options> */
-  MathJax = {
-    tex: {
-      inlineMath: [              /* start/end delimiter pairs for in-line math */
-        ['$','$'],
-        ['\\(','\\)']
-      ],
-      displayMath: [             /* start/end delimiter pairs for display math */
-        ['$$', '$$'],
-        ['\\[', '\\]']
-      ]
-    }
-  };
-</script>
-<script src="{{ site.data.assets[origin].polyfill.js | relative_url }}"></script>
-<script id="MathJax-script" async src="{{ site.data.assets[origin].mathjax.js | relative_url }}">
-</script>
-{% endif %}
-
 <!-- Bootstrap JS -->
 <script src="{{ site.data.assets[origin].bootstrap.js | relative_url }}"></script>
 
 {% if jekyll.environment == 'production' %}
-<!-- PWA -->
-{% if site.pwa.enabled %}
-<script defer src="{{ '/app.js' | relative_url }}"></script>
-{% else %}
-<script defer src="{{ '/unregister.js' | relative_url }}"></script>
-{% endif %}
-
+    <!-- PWA -->
+    {% if site.pwa.enabled %}
+        <script defer src="{{ '/app.js' | relative_url }}"></script>
+    {% else %}
+        <script defer src="{{ '/unregister.js' | relative_url }}"></script>
+    {% endif %}
 {% endif %}

data/_includes/{elements → components}/navbar.html

@@ -1,6 +1,13 @@
-{% comment %} NAVBAR {% endcomment %}
+<!-- NAVBAR -->
 <nav>
+    <div class="container-fluid">
+        <ul class="navbar-nav">
+
+        </ul>
+    </div>
+
+
     {% for item in site.data.navigation %}
         <a href="{{ item.link }}" {% if page.url == item.link %}style="color: red;"{% endif %}>{{ item.name }}</a>
     {% endfor %}
-</nav>
+</nav>

data/_includes/{elements/jsdelivr-combine.html → functions/js-combine.html}

@@ -12,7 +12,7 @@
     {% elsif url contains '//' %}
         <script src="{{ url }}"></script>
     {% else %}
-        <script src="{{ url | relative_url }}"></script>
+            <script src="{{ url | relative_url }}"></script>
     {% endif %}
 {% endfor %}
 {% if combined_urls %}<script src="{{ combined_urls }}"></script>{% endif %}

data/_includes/head.html

@@ -24,7 +24,7 @@
 
     <title>{% unless page.layout == "home" %}{{ page.title | append: " | "}}{% endunless %}{{ site.title }}</title>
 
-    {% include elements/favicons.html %}
+    {% include components/favicons.html %}
 
     {% if site.resources.ignore_env != jekyll.environment and site.resources.self_hosted %}
     <link href="{{ site.data.assets[origin].webfonts | relative_url }}" rel="stylesheet">

data/_includes/views/header-banner.html

@@ -1 +1,9 @@
-{% comment %} HEADER-BANNER {% endcomment %}
+<!-- HEADER-BANNER -->
+
+<header id="banner">
+    <div id="header">
+        {% ifhascontent header %}
+            {% contentblock header %}
+        {% endifhascontent %}
+    </div>
+</header>

data/_includes/views/header-wide.html

@@ -1 +1,9 @@
-{% comment %} HEADER-WIDE {% endcomment %}
+<!-- HEADER-WIDE -->
+
+<header id="wide">
+    <div id="header">
+        {% ifhascontent header %}
+            {% contentblock header %}
+        {% endifhascontent %}
+    </div>
+</header>

data/_includes/views/header.html

@@ -1 +1,9 @@
-{% comment %} HEADER-REGULAR {% endcomment %}
+<!-- HEADER-REGULAR -->
+
+<header id="regular">
+    <div id="header">
+        {% ifhascontent header %}
+            {% contentblock header %}
+        {% endifhascontent %}
+    </div>
+</header>