jekyll-theme-paperwiki 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32430026a29a1decc9d92705e3f1336395a65c9be44f3a387205cec506d67715
-  data.tar.gz: 733272820457e6703e6daa126934a071a6b60a93c444919aad1e89c95ffb26d1
+  metadata.gz: 78d439ead8b550000787d732b642e1829573ebf29469d5b6ff9f8d0b0c18e66e
+  data.tar.gz: f561e73ae1dab1cdbf85d6be9916eb28190d4d394dffc5e4f23d2260dab94d42
 SHA512:
-  metadata.gz: f79e6b438e249885f89bcf44e0edcfa6b979a4632135476a74c961abe165485a7949584720ad868806f86c80df712a1b13e6f3e296d821e6279b310cc77bf20e
-  data.tar.gz: f45184bb764bc317f2b38ed45544df362e22144f272a00329eb9517bc3145a2f0b48ab23881466c90d1277937913a0c4a286a5422a46f4bd4395c3ff517a094f
+  metadata.gz: e9f307d6177caaa530e338c2994bb2058b85b07bf511eb836b98cb8eca87fe528740b5d2d6fd69ff0ccd6c6e99e05499c2b7ff4f987d5e8978a9556f9d93b9b1
+  data.tar.gz: bb3cd0ed030574bac2b84d26f9c147c7adceb8c7c78ed77bf0537973e0693567f65f569a9ecc305c3b84b10cade78da0c6aa308fc62c1f22b011c091da9f5ec0

data/_config.yml

@@ -0,0 +1,119 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Encyclopedia
+email: your-email@example.com
+description: >- # this means to ignore newlines until "baseurl:"
+  Write an awesome description for your new site here. You can edit this
+  line in _config.yml. It will appear in your document head meta (for
+  Google search results) and in your feed.xml site description.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+github_username: pomeloshark
+
+# Build settings
+include: ['_pages'] # forces custom pages to be organized into their own directory
+# theme: jekyll-theme-paperwiki
+
+# Enables random page functionality
+random_redirect:
+  posts: false # excludes posts from random page functionality
+
+# Display tags at the top of articles. Change to false if you want them to display
+# at the bottom instead.
+entry_tags_top: true
+
+
+
+##################################################################################
+# If you set this to true, MAKE SURE to change the collections and defaults below,
+# otherwise the site will not behave correctly!
+##################################################################################
+multi_projects: true
+
+collections_dir: collections # specifies the location of the collections
+collections:
+   wiki:
+      output: true # creates a rendered page for each document in the collection
+      permalink: /:collection/:title # outputs /wiki/name-of-article, no file extension
+# If you want to have more than one collection and have set multi_projects to true, just uncomment the below lines, rename the collection, and create a corresponding folder in your collections folder. This folder must have a preceding underscore, as in '_wiki'. You can have as many collections as you like; make sure to both create a folder for each and make an entry for each in your projects.yml.
+   works:
+      output: true
+      permalink: /:collection/:title
+   grammars:
+      output: true
+      permalink: /:collection/:title
+
+
+
+# Front matter defaults, so you don't need to set layouts on every new page.
+# As long as pages are in the correct folder, they'll automatically have the
+# correct layout. You can override this via each page's front matter.
+defaults:
+   -
+      scope:
+         path: "" # an empty string here means all files in the project
+         type: "pages" # narrows it down to only all pages, instead of posts or drafts; not particularly relevant for this theme since blogging is not featured heavily
+      values:
+         layout: "page"
+         permalink: "/:path/:basename"
+   -
+      scope:
+         path: "collections" # all pages in the collections folder
+      values:
+         layout: "entry" # the basic layout that wiki and other entry pages are built on
+   -
+      scope:
+         path: "_wiki" # all pages in the wiki folder
+      values:
+         layout: "wiki"
+# If you want to have more than one collection and have set multi_projects to true, just uncomment the below lines and add in your collection's name, again with preceding underscore.
+   -
+      scope:
+         path: "_works" # all pages in the corresponding folder
+      values:
+         layout: "work" # see the about page for more on entry layouts
+   -
+      scope:
+         path: "_grammars" # all pages in the corresponding folder
+      values:
+         layout: "grammar" # see the about page for more on entry layouts
+
+
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+# exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules/
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/_data/navigation.yml

@@ -1,3 +1,4 @@
+# These are the links that appear in the topbar on every page.
 - name: About
   link: /about
 - name: Random

data/_includes/collections_header.html

@@ -1,17 +1,23 @@
 <section class="collections-header">
 
    <section class="collections-stats">
+      
       {% if site.multi_projects %}
+
          {% for item in site.data.projects %}
+
             {% if page.url contains item.link %}
                Total number of {{ item.name | downcase }} entries:
                   <strong>{{ site.[page.project].size }}</strong>
             {% endif %}
+
          {% endfor %}
+
       {% else %}
          Total number of wiki entries:
             <strong>{{ site.wiki.size }}</strong>
       {% endif %}
+
    </section>
 
 
@@ -19,13 +25,17 @@
    <section class="collections-search">
 
       {% if site.multi_projects %}
+
          {% for item in site.data.projects %}
+
             {% if page.url contains item.link %}
                <form action="{{ item.link }}:search" method="GET">
                   <input required type="search" class="collections-searchbar" placeholder="Search all {{ item.name | downcase }} entries" name="q">
                </form>
             {% endif %}
+
          {% endfor %}
+
       {% else %}
          <form action="/wiki:search" method="GET">
             <input required type="search" class="collections-searchbar" placeholder="Search all wiki entries" name="q">

data/_includes/collections_sidebar.html

@@ -1,17 +1,21 @@
 <nav class="collections-sidebar">
 
    {% if site.multi_projects %}
+
       {% for item in site.data.projects %}
+
          {% if page.url contains item.link %}
-         <ul>
-            <li><a href="{{ item.link }}">Main page</a></li>
-            <li><a href="{{ item.link }}:contents">Contents</a></li>
-            <li><a href="{{ item.link }}:all">All entries</a></li>
-            <li><a href="{{ item.link }}:random">Random article</a></li>
-            <li><a href="{{ item.link }}:about">About</a></li>
-         </ul>
+            <ul>
+               <li><a href="{{ item.link }}">Main page</a></li>
+               <li><a href="{{ item.link }}:contents">Contents</a></li>
+               <li><a href="{{ item.link }}:all">All entries</a></li>
+               <li><a href="{{ item.link }}:random">Random article</a></li>
+               <li><a href="{{ item.link }}:about">About</a></li>
+            </ul>
          {% endif %}
+
       {% endfor %}
+      
    {% else %}
       <ul>
          <li><a href="/wiki">Main page</a></li>

data/_includes/entry_tags.html

@@ -13,6 +13,7 @@
 
    <span class="entry-subhead_key">Categories:</span>
    <span>
+      <!-- This logic iterates through every "category" item in the front matter and generates a link for each one. -->
       {% for item in page.categories %}
          <a href="/{{ page.collection }}/category:{{ item | slugify }}" class="entry-subhead_value">
             {{ item }}
@@ -26,8 +27,9 @@
 
    <span class="entry-subhead_key">Tags:</span>
    <span>
+      <!-- This logic iterates through every "tags" item in the front matter and generates a link for each one. -->
       {% for item in page.tags %}
-         <a href="/{{ page.category }}/tag:{{ item }}" class="entry-subhead_value">
+         <a href="/{{ page.collection }}/tag:{{ item }}" class="entry-subhead_value">
             {{ item }}
          </a>
       {% endfor %}

data/_includes/global_header.html

@@ -1,14 +1,17 @@
 <header class="global-header">
 
    <h1 class="global-logo">
+
       <a href="/">
          <img src="/assets/images/favicon.png" class="global-favicon">
          {{ site.title | capitalize }}
       </a>
+      
    </h1>
 
    <nav class="global-nav">
 
+      <!-- This logic iterates through every item in the data.navigation.yml file and generates a link for each one. -->
       {% for item in site.data.navigation %}
          <a href="{{ item.link }}" class="global-nav-link">
             {{ item.name }}

data/_includes/random_redirect.html

@@ -22,4 +22,5 @@
    } else {
       window.location.replace(url);
    }
+   
 </script>

data/_includes/wiki_sidebar.html

@@ -3,14 +3,27 @@
    {% if page.other_projects %}
 
       <section class="entry-other_projects">
+
          View in other collections:
+
          <ul>
+
             {% for item in page.other_projects %}
-               <li>
-                  <a href="/{{ item }}{{ page.url | remove_first: "/wiki" }}">{{ item | capitalize }}</a>
-               </li>
+
+               {% if other_projects == "grammars" %}
+                  <li>
+                     <a href="/{{ item }}{{ page.language | remove_first: "/wiki"  }}">{{ item | capitalize }}</a>
+                  </li>
+               {% else %}
+                  <li>
+                     <a href="/{{ item }}{{ page.url | remove_first: "/wiki" }}">{{ item | capitalize }}</a>
+                  </li>
+               {% endif %}
+
             {% endfor %}
+
          </ul>
+
       </section>
 
    {% endif %}
@@ -19,10 +32,15 @@
 
    {% if page.image %}
       <figure>
+
          <img src="{{ page.image }}" width=auto class="entry-image">
+
          {% if page.image_caption %}
-            <figcaption>{{ page.image_caption }}</figcaption>
+            <figcaption>
+               {{ page.image_caption }}
+            </figcaption>
          {% endif %}
+
       </figure>
    {% endif %}
 
@@ -33,20 +51,15 @@
       <section class="entry-quickstats">
 
          <table class="stats-table">
+            
+            <!-- This logic iterates through every "quickstats" key-value pair in the front matter and generates a table row for each one. -->
             {% for stat in page.quickstats %}
-               {% if stat[0] == "colspan_2" %}
-                  <tr>
-                     <td colspan="2" class="entry-quickstats_double">
-                        {{ stat[1] | replace: "_", " " | capitalize }}
-                     </td>
-                  </tr>
-               {% else %}
-                  <tr>
-                     <td>{{ stat[0] | replace: "_", " " | capitalize }}</td>
-                     <td>{{ stat[1] }}</td>
-                  </tr>
-               {% endif %}
+               <tr>
+                  <td>{{ stat[0] | replace: "_", " " | capitalize }}</td>
+                  <td>{{ stat[1] }}</td>
+               </tr>
             {% endfor %}
+
          </table>
 
       </section>

data/_layouts/collections.html

@@ -7,7 +7,7 @@
 <section class="collections-content">
 
    {% if page.title %}
-   <h1>{{ page.title }}</h1>
+      <h1>{{ page.title }}</h1>
    {% endif %}
 
    {{ content }}

data/_layouts/portal.html

@@ -3,6 +3,7 @@
 ---
 
 {% for item in site.data.portals_wiki %}
+
    {% if page.title contains item.name %}
 
       <ul class="portal-list">
@@ -10,25 +11,28 @@
          {% for item in item.categories %}
 
             <li class="portal-cat">
+
                <a href="{{ item.link }}">{{ item.cat }}</a>
 
                {% if item.subcategories %}
+
                   <ul class="portal-subcat_list">
 
                      {% for item in item.subcategories %}
-                           <li class="portal-subcat_inline">
-                              <a href="{{ item.link }}" class="portal-subcat">{{ item.subcat }}</a>
-
-                              {% if item.tags %}
-                                 ⋅
-                                 {% for item in item.tags %}
-                                    <a href="" class="portal-tag">{{ item.tag }}</a>
-                                 {% endfor %}
-                              {% endif %}
-                           </li>
+                        <li class="portal-subcat_inline">
+                           <a href="{{ item.link }}" class="portal-subcat">{{ item.subcat }}</a>
+
+                           {% if item.tags %}
+                              ⋅
+                              {% for item in item.tags %}
+                                 <a href="" class="portal-tag">{{ item.tag }}</a>
+                              {% endfor %}
+                           {% endif %}
+                        </li>
                      {% endfor %}
 
                   </ul>
+
                {% endif %}
 
             </li>
@@ -38,4 +42,5 @@
       </ul>
 
    {% endif %}
+
 {% endfor %}

data/_layouts/random.html

@@ -8,7 +8,7 @@
 {%- assign docs = site.documents -%}
 
 {%- if site.random_redirect.posts == true -%}
-  {%- assign docs = docs | concat: site.posts -%}
+   {%- assign docs = docs | concat: site.posts -%}
 {%- endif -%}
 
 {% include random_redirect.html %}

data/_layouts/reference_desk.html

@@ -5,27 +5,34 @@
 {% include collections_header.html %}
 
 
+
 <section class="reference-desk">
 
-      <header class="collections-portals">
-         <nav class="collections-portals_grid">
-
-            {% for item in site.data.projects %}
-               {% if page.url contains item.link %}
-                  {% for item in item.portals %}
-                     <a href="{{ item.link }}" class="collections-portal_card">
-                        <header>
-                           <i class="{{ item.icon }} portal-icon"></i>
-                           {{ item.portal }}
-                        </header>
-                        {{ item.summary }}
-                     </a>
-                  {% endfor %}
-               {% endif %}
-            {% endfor %}
-
-         </nav>
-      </header>
+   <header class="collections-portals">
+
+      <nav class="collections-portals_grid">
+
+         {% for item in site.data.projects %}
+
+            {% if page.url contains item.link %}
+
+               {% for item in item.portals %}
+                  <a href="{{ item.link }}" class="collections-portal_card">
+                     <header>
+                        <i class="{{ item.icon }} portal-icon"></i>
+                        {{ item.portal }}
+                     </header>
+                     {{ item.summary }}
+                  </a>
+               {% endfor %}
+
+            {% endif %}
+
+         {% endfor %}
+
+      </nav>
+
+   </header>
 
    <!---
 

data/_sass/partials/_base.scss

@@ -1,6 +1,7 @@
 /*------------------------------------*\
   # BASE STYLING
-  # styling universal to all pages
+  # styling universal to all pages:
+  # typography, layout, inputs
 \*------------------------------------*/
 
 html {

data/_sass/partials/_entries.scss

@@ -10,6 +10,11 @@
 
    border-left: 1px solid $color-article_border;
    border-right: 1px solid $color-article_border;
+
+   ul,
+   li {
+      margin-right: 0;
+   }
 }
 
 .entry_wiki,

data/_sass/partials/_global.scss

@@ -1,6 +1,7 @@
 /*------------------------------------*\
   # GLOBAL STYLING
-  # components universal to all pages
+  # components universal to all pages:
+  # header and footer
 \*------------------------------------*/
 
 .global-header,
@@ -16,6 +17,8 @@
    position: sticky;
    top: 0;
 
+   z-index: 100;
+
    display: flex;
    align-items: center;
    justify-content: space-between;

data/assets/css/css.scss

@@ -2,4 +2,5 @@
 # Front matter comment to ensure Jekyll properly reads file.
 ---
 
+/* This file imports all of the SCSS to convert it into CSS that Jekyll can read. */
 @import "style";