jekyll-ham 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c514e70f5dcb6ad4c9c6d6b1f9e3cfd4a17d52ba637fb06ebd7c16ce00b6b2
-  data.tar.gz: b58213fec13c4e37719cd7c8b1688c94053834406995929a2eddf5c0085756d8
+  metadata.gz: 25efbdc5f614e94b7027ebb7115268b62fb9a85fd59f61dbf36ad6f52dc8d373
+  data.tar.gz: 07e0dc8914bb3172786efcd17920bcc358f63a563295c093d6a4c2820ae16b4d
 SHA512:
-  metadata.gz: 3d853b6f2e013655cc92f5301826a8340d136bf9d0a1a990f435f42286cb4d8dc766ca1f541daa6dbe75cac91cb3c17b451d5c1c94c5e389988abc1ffd52ceff
-  data.tar.gz: 37bf21a9c4f03831ff721e0208c0a3799d6e119dd8c4e456c746e750594fb4a46ab628f05c865bff1d2ec66c324c167a98168cd69530d978aab201ec102a3fab
+  metadata.gz: '091bd4e837cab4a04b5533df895400742fcf797689fc39b5d87bddcd605816778d66542e780ce2f9d9f538e5223df21d8aaa8d94ee1de1c77c72ffcdb26a87b0'
+  data.tar.gz: 0f4956f720338fabcfbfb0e92b49dbb4dcdc2cce9f5495ce499cc6f879be41e694d5f2a95c58ada60480faa977719c7938e2abe214090b5fedb48efaf5b665c3

data/README.md

@@ -58,7 +58,17 @@ HAM is short for:
 - [ ] Supporting Forem (DEV.to) liquid tags (YouTube embeds, Twitter posts, etc.)
 
 ## Usage
-**You don't need to clone this project to use HAM on your own wiki.** It's available as a [Gem-based theme](https://rubygems.org/gems/jekyll-ham) on the official Ruby gems repository. If you are unsure on installing gem-based themes like this one, check out the [official Jekyll documentation](https://jekyllrb.com/docs/themes/#installing-a-theme) for that.
+### For [GitHub Pages](https://pages.github.com)
+If you would like to add this theme into your GitHub Pages website, please just add the following on your `_config.yml`
+
+```
+remote_theme: reinhart1010/HAM
+```
+
+The best part of this is that you can get the latest version of HAM without manually requiring it on your Gemfile, as long as you have updated your page frequently (GitHub will fetch the current available version of the HAM "theme").
+
+### As a Gem-based theme
+HAM is also available as a [Gem-based theme](https://rubygems.org/gems/jekyll-ham) on the official Ruby gems repository. If you are unsure on installing gem-based themes like this one, check out the [official Jekyll documentation](https://jekyllrb.com/docs/themes/#installing-a-theme) for that.
 
 If you have just created a new site with `jekyll new <PATH>` chances are that you're using the default, Minima theme instead of HAM. If that's the case, replace the line which begins with
 
@@ -75,7 +85,7 @@ gem "jekyll-ham", "~> 0.1.2"
 Also don't forget to change the `theme` configuration on your `_config.yml` to `jekyll-ham` instead of `minima`.
 
 ### Site does not load properly after first `jekyll build`?
-Make sure that all of your Markdown and HTML files include the following frontmatter:
+In previous versions of HAM (0.1.5 and earlier), all of your Markdown and HTML files must include the following frontmatter:
 
 ```yaml
 ---
@@ -83,7 +93,7 @@ layout: page
 ---
 ```
 
-This ensures that the default page template (as defined in our `_layouts/page.html`) is used to load the entire content
+However, as of 0.1.6 `jekyll-optional-front-matter` has been included and configured by default to remove this requirement, which allows easier content migration for future wikis.
 
 ### Changing the `_config.yml`
 HAM also introduces additional configuration which you can set on your `_config.yml`:

data/_config.yml

@@ -1,3 +1,8 @@
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "page"
 ham:
   site_icon: https://raw.githubusercontent.com/googlefonts/noto-emoji/main/svg/emoji_u1f969.svg
 highlighter: rouge
@@ -5,6 +10,7 @@ kramdown:
   input: GFM
   syntax_highlighter: rouge
 plugins:
+  - jekyll-optional-front-matter
   - jekyll-readme-index
   - jekyll-seo-tag
   - jekyll-sitemap
@@ -12,5 +18,6 @@ plugins:
 tagline: The truly static, Git-based wiki project
 title: HAM
 theme: jekyll-ham
+url: ./
 readme_index:
   with_frontmatter: true

data/_includes/comments.html

@@ -0,0 +1,21 @@
+{% if site.ham.contributing != null %}
+  {% if site.ham.contributing != null %}
+    {% if site.ham.contributing.discuss.type != null && site.ham.contributing.discuss.type != 'url' %}
+      <h5 id="discuss" class="sidebar-title">Discuss this page</h5>
+      <div class="sidebar-title">
+        {% case site.ham.contributing.discuss.type %}
+          {% when 'giscus' %}
+            <script src="https://giscus.app/client.js" data-repo="{{ site.ham.contributing.discuss.repo }}" data-repo-id="{{ site.ham.contributing.discuss.repo_id }}" data-category="{{ site.ham.contributing.discuss.category }}" data-category-id="{{ site.ham.contributing.discuss.category_id }}" data-mapping="{{ site.ham.contributing.discuss.mapping }}" data-reactions-enabled="{{ site.ham.contributing.discuss.reactions_enabled | default: 1 }}" data-emit-metadata="{{ site.ham.contributing.discuss.emit_metadata | default: 0 }}" data-theme="{{ site.ham.contributing.discuss.theme | default: 'preferred_color_scheme' }}" data-lang="{{ site.ham.contributing.discuss.lang | default: 'en' }}" crossorigin="anonymous" async></script>
+          {% when 'telegram' %}
+            <script src="https://telegram.org/js/telegram-widget.js?15" {% if site.ham.contributing.discuss.telegram_discussion != null %} data-telegram-discussion="{{ site.ham.contributing.discuss.telegram_discussion }}" {% endif %} data-comments-limit="{{ site.ham.contributing.discuss.comments_limit | default: '5' }}" {% if site.ham.contributing.discuss.height != null %} data-height="{{ site.ham.contributing.discuss.height }}" {% endif %} data-color="{{ site.ham.contributing.discuss.color | default: '319BE6' }}" data-dark-color="{{ site.ham.contributing.discuss.color | default: '4BA3E2' }}" data-colorful="{{ site.ham.contributing.discuss.colorful | default: 0 }}" data-dark="{{ site.ham.contributing.discuss.dark | default: 0 }}" crossorigin="anonymous" async></script>
+          {% when 'utteranc.es' %}
+            <script src="https://utteranc.es/client.js" repo="{{ site.ham.contributing.discuss.repo }}" issue-term="{{ site.ham.contributing.discuss.issue_term }}"
+            {% if site.ham.contributing.discuss.label != null %}
+              label="{{ site.ham.contributing.discuss.label }}"
+            {% endif %}
+          theme="{{ site.ham.contributing.discuss.theme | default: 'preferred-color-scheme' }}" crossorigin="anonymous" async></script>
+        {% endcase %}
+      </div>
+    {% endif %}
+  {% endif %}
+{% endif %}

data/_includes/sidebar.html

@@ -1,4 +1,4 @@
-<div class="sidebar">
+<aside class="sidebar">
   <div class="sidebar-menu">
     <h5 id="on-this-page" class="sidebar-title">On This Page</h5>
     <div class="sidebar-divider"></div>
@@ -31,6 +31,21 @@
           View Source
         </a>
       {% endif %}
+    <br>
+    {% endif %}
+    {% if site.data.index %}
+      {% for section in site.data.index %}
+        <h5 class="sidebar-title">
+          {{ section.name }}
+        </h5>
+        <div class="sidebar-divider"></div>
+        {% for child in section.children %}
+          <a href="{{ child.url }}" class="sidebar-link">
+            <span class="name">{{ child.name }}</span>
+          </a>
+        {% endfor %}
+        <br>
+      {% endfor %}
     {% endif %}
   </div>
-</div>
+</aside>

data/_layouts/default.html

@@ -17,8 +17,10 @@
   <!-- Bootstrap Icons CSS -->
   <link href="{{ site.url }}/assets/bootstrap-icons.min.css" rel="stylesheet" />
   
-  <!-- Additional CSS -->
+  <!-- Core CSS required for HAM to work properly -->
   <link href="{{ site.url }}/assets/default.css" rel="stylesheet" />
+
+  <!-- Additional CSS -->
   <link href="{{ site.url }}/assets/main.css" rel="stylesheet" />
   <link href="{{ site.url }}/assets/syntax-highlighter.css" rel="stylesheet" />
 
@@ -43,7 +45,7 @@
     var sjs = SimpleJekyllSearch({
       searchInput: document.getElementById('search-input'),
       resultsContainer: document.getElementById('results-container'),
-      json: '{{ site.url }}/search.json'
+      json: '{{ site.url }}/assets/search.json'
     })
   </script>
   <!-- Halfmoon JS -->

data/_layouts/page.html

@@ -1,7 +1,7 @@
 ---
 layout: default
 ---
-<div class="row">
+<article class="row">
   <div class="col-xl-8 p-20 collapse-group article-wrapper" id="_ham_content">
     {{ content }}
   </div>
@@ -27,6 +27,7 @@ layout: default
         {% include external-link.html %}
       {% endfor %}
     {% endif %}
+    {% include comments.html %}
   </div>
 </div>
 

data/assets/default.css

@@ -1,17 +1,4 @@
-:root {
-  --font-family-serif: 'Linux Libertine', 'Linux Libertine Display O', Georgia, 'Noto Serif', 'Times New Roman', Times, serif;
-  --heading-font-weight: 700;
-}
-
-/* Use serif font for headings (a-la MediaWiki) */
-.article-wrapper h1, .article-wrapper h2, .content-wrapper .h1, .content-wrapper .h2 {
-  font-family: var(--font-family-serif);
-  font-weight: 400;
-}
-.article-sitesub {
-  font-family: var(--font-family-serif);
-  font-style: italic;
-}
+@import url('custom.css');
 
 /* Lowers the font size for H3, H4, H5, H6 */
 .article-wrapper h3, .content-wrapper .h3 {
@@ -60,3 +47,7 @@
 .content-wrapper .highlighter-rouge {
   border-radius: var(--card-border-radius);
 }
+
+article img {
+  max-width: 100%;
+}

data/assets/main.css

@@ -1 +1,15 @@
 /* TODO: Add your CSS here (Jekyll will override it) */
+:root {
+  --font-family-serif: 'Linux Libertine', 'Linux Libertine Display O', Georgia, 'Noto Serif', 'Times New Roman', Times, serif;
+  --heading-font-weight: 700;
+}
+
+/* Use serif font for headings (a-la MediaWiki) */
+.article-wrapper h1, .article-wrapper h2, .content-wrapper .h1, .content-wrapper .h2 {
+  font-family: var(--font-family-serif);
+  font-weight: 400;
+}
+.article-sitesub {
+  font-family: var(--font-family-serif);
+  font-style: italic;
+}

data/assets/search.json

@@ -0,0 +1,16 @@
+---
+layout: none
+---
+[
+  {% for page in site.pages %}
+    {
+      {% if page.url != '/assets/search.json' and page.url != '/sitemap.xml' and page.url != '/robots.txt' %}
+      "title"    : "{% if page.url == '/' %}Main Page{% else %}{{ page.title | escape }}{% endif %}",
+      "category" : "{{ page.category }}",
+      "tags"     : "{{ page.tags | join: ', ' }}",
+      "url"      : "{{ site.baseurl }}{{ page.url }}",
+      "date"     : "{{ page.date }}"
+      {% endif %}
+    } {% unless forloop.last %},{% endunless %}
+  {% endfor %}
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ham
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Reinhart Previano Koentjoro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: jekyll-optional-front-matter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: jekyll-readme-index
   requirement: !ruby/object:Gem::Requirement
@@ -121,19 +135,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.26.1
 - !ruby/object:Gem::Dependency
-  name: wdm
+  name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '3.7'
 description:
 email:
 - reinhart@reinhart1010.id
@@ -144,6 +158,7 @@ files:
 - LICENSE.txt
 - README.md
 - _config.yml
+- _includes/comments.html
 - _includes/external-link.html
 - _includes/footer.html
 - _includes/navbar.html
@@ -160,6 +175,7 @@ files:
 - assets/halfmoon-variables.min.css
 - assets/halfmoon.min.js
 - assets/main.css
+- assets/search.json
 - assets/simple-jekyll-search.min.js
 - assets/syntax-highlighter.css
 homepage: https://github.com/reinhart1010/ham