jekyll-theme-paperwiki 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4fdedc32cb88321f3a4f385ebce2e51ff63a50f04a1d0bda529fca11039a519
-  data.tar.gz: 666179a519fad2588b6c4fac26a9fa5434e7f4720efe5b2f953105d1e5d7c3b0
+  metadata.gz: bd5647356250d27a51862ad94ca40a17ba4ec33bec742b95d09a3dc38c0f3d9b
+  data.tar.gz: 817ac6d86315dac8b99e4e8c88f07ae5d5ecb0b4028f4fa70ca21127287ece04
 SHA512:
-  metadata.gz: d8ee82260e046e1983299f4637de1bddb380c809ecced5a7462696ca78c085b3d6fdfe07c6c9ac60a3e759235c4869b1b30d6d41e2707448ad06452e0544170d
-  data.tar.gz: 10faec06628838ef30f2cab51831f1397988a28e5bc9a35151f2cca1055c9a7e033e9442c7ee21a3f5b429969ed6a6b46140bc4a34e19f248cfd46b99a0dff5e
+  metadata.gz: c0ead5a13368865eca2b9c0d8c190dd563182b5b3ec085214b34230203583196e2fc2d2c4efe192cec12fb151ae75fba9a19977136c7eda1252de50b5664a163
+  data.tar.gz: 89ae3bfe1fc0eaf2ef2bf0991bb2eb0e74c44be1f9f8f1c9ae25fd0c08a0e4bf5759c581498e35528ea31d2124a27647071b6644288ce659b1d933b2dfb5cfca

data/README.md

@@ -1,6 +1,8 @@
 # jekyll-theme-paperwiki
 
-The intent of this theme is to get all the code out of the way and to allow you to write Markdown articles.
+The intent of this theme is to get all the code out of the way and to allow you to write Markdown articles; the best way to do that is to install the theme as a gem. However, if you want to tinker with the code, just download this repository.
+
+This theme is not mobile friendly, as I personally do absolutely no worldbuilding on mobile and thus my development skills are lacking. There is also no dark mode or other alternate colour scheme, but please feel free to fork this project and add whatever functionality it's missing.
 
 
 
@@ -21,14 +23,35 @@ This theme comes with all of these prepackaged, so most of what you have to do i
 
 [Install Jekyll](https://jekyllrb.com/docs/). Create a new site by running the following in your terminal:
 
-   $ jekyll new MYSITENAME
+```
+$ jekyll new MYSITENAME
+```
+
+This will give you a very bare bones Jekyll site, with an index page, a folder for blog posts, a config file, and a Gemfile. You'll have to do a little setup to make it usable with this theme. Here's what the directory should look like:
+
+```
+.
+├── _pages/
+│   ├── wiki/ # In here is where your organizational pages for your wiki will go.
+├── _posts/ # If you want to write blog posts, they go in here.
+├── _site/
+├── collections/
+│   ├── _wiki/ # In here is where all your articles will go, in markdown or html files.
+├── _config.yml
+├── 404.html
+├── about.md
+├── Gemfile
+├── index.md
+```
 
-This will give you a very bare bones Jekyll site, with an index page, a folder for blog posts, a config file, and a Gemfile. You will want to add a folder called `collections`, and inside of that another folder called `_wiki`.
+(Don't worry about the .gitignore or the Gemfile.lock.)
+
+(You can also move your `_posts` folder into your `collections` folder if you want; I find it makes things a little neater.)
 
 To use this theme, open your Jekyll site's `Gemfile`, delete the line that says `gem "minima"` and replace it with this line:
 
 ```ruby
-gem "jekyll-theme-paperwiki"
+gem "jekyll-theme-paperwiki", "~> 0.1.2"
 ```
 
 And add this line to your Jekyll site's `_config.yml`:
@@ -49,7 +72,32 @@ Or install it yourself as:
 $ gem install jekyll-theme-paperwiki
 ```
 
+To serve your site locally, navigate into the site's directory and run:
+
+```
+$ bundle exec jekyll serve
+```
+
+Navigate to your localhost and...you will see an empty page. This is because the layout in the default `index.md` is not set properly. Open this file and change the layout like so:
+
+```yaml
+layout: launchpad
+```
+
+This will show you the default wiki homepage. The three links - explore, contents, and random page - link to pages that are included with the theme, and consist of pregenerated content based on the wiki articles you've written. Now you can start adding articles in your `_wiki` folder.
+
+### Using the wiki
 
+All of your wiki pages should be written in markdown, and you must begin each `.md` file like so:
+
+```
+---
+---
+```
+
+Between these two lines is where you include *front matter*, such as specifying the layout or the permalink to the page. However, you can leave the front matter blank - wiki pages have layouts and permalinks set by default in the theme's config file, and you only need to specify them if you want to override the defaults. You also do not need to specify a title for the page, as it is automatically taken from the filename. All you absolutely need is the two triple-dashed lines, as Jekyll needs it to know that the front matter is there in order to output the page.
+
+​
 
 ## Config
 
@@ -73,7 +121,7 @@ However, if you would like to have additional collections akin to the Wikimedia
       permalink: /:collection/:name
 ```
 
-Make sure to add the corresponding folders within `collections`, including the preceding underscore.
+Make sure to add the corresponding folders within `collections`, including the preceding underscore: `_literature`, `_dictionary`, etc.
 
 Add into your `_config.yml`:
 
@@ -81,7 +129,18 @@ Add into your `_config.yml`:
 multi_projects: true
 ```
 
-This will add links to each different collection on your homepage, and allow you to limit the scope of your searches to a single collection or expand it to cover all of them at once.
+You will also need to add a data file listing your projects: create a folder titled `_data` and inside it a file titled `projects.yml`. Within it you need to list the following, formatted in the same way:
+
+``` yaml
+- name: Wiki
+  link: /wiki
+  icon: ri-global-line
+  desc: A brief description here
+```
+
+For the icon, find one you like from RemixIcon and copy the code.
+
+This will add links to each different collection on your homepage, and allow you to limit the scope of your searches to a single collection or expand it to cover all of them at once. You do not need to do anything to
 
 
 
@@ -100,6 +159,6 @@ The theme is available as open source under the terms of the [MIT License](https
 
 ## Credits
 
-This theme uses the fonts [Inter](https://rsms.me/inter/), [Libertinus Serif](https://github.com/alerque/libertinus), and [Liberation Mono](https://fontlibrary.org/en/font/liberation-mono), all of which are released under the SIL Open Font License; and the icon font [RemixIcon](https://remixicon.com/), which is available under the Apache License 2.0. The [example favicon](https://www.flaticon.com/free-icon/picture_4671171) is by Royyan Wijaya at Flaticon.
+This theme uses the fonts [Inter](https://rsms.me/inter/), [Libertinus Serif](https://github.com/alerque/libertinus), and [Liberation Mono](https://fontlibrary.org/en/font/liberation-mono), all of which are released under the SIL Open Font License; and the icon font [RemixIcon](https://remixicon.com/), which is available under the Apache License 2.0. The [example favicon](https://www.flaticon.com/free-icon/toucan_3002355) is by Freepik at Flaticon.
 
 The search function uses [Lunr.js](https://lunrjs.com/).

data/_config.yml

@@ -1,55 +1,15 @@
-# 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: Your Title Here
-
 # Build settings
-theme: jekyll-theme-paperwiki
 include: ['_pages'] # forces custom pages to be organized into their own directory
 
-# 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/
-
-#
 collections_dir: collections
 collections:
    wiki:
       output: true
       permalink: /:collection/:name
 
+random_redirect:
+   pages: true
+
 # 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.
@@ -59,7 +19,7 @@ defaults:
          path: "" # an empty string here means all files in the project
          type: "pages"
       values:
-         layout: "page"
+         layout: "page" # all pages will have the page.html layout unless overridden
          permalink: "/:path/:basename"
    -
       scope:

data/_data/navigation.yml

@@ -1,4 +1,6 @@
 - name: About
   link: /about
+- name: Random
+  link: /random
 - name: Blog
   link: /blog

data/_includes/collections_header.html

@@ -0,0 +1,30 @@
+<section class="collections-header">
+
+   <section class="collections-stats">
+      {% for item in site.data.projects %}
+         {% if page.url contains item.link %}
+            Total number of {{ item.name | downcase }} entries:
+            {% if item.name == "Wiki" %}
+               {{ site.wiki.size }}
+            {% else %}
+               ? for now
+            {% endif %}
+         {% endif %}
+      {% endfor %}
+   </section>
+
+
+
+   <section class="collections-search">
+
+      {% 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 %}
+
+   </section>
+
+</section>

data/_includes/collections_sidebar.html

@@ -1,3 +1,15 @@
 <nav class="collections-sidebar">
 
+   {% 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>
+      {% endif %}
+   {% endfor %}
+
 </nav>

data/_includes/global_header.html

@@ -17,7 +17,6 @@
 
       <form class="global-search" action="/search" method="GET">
          <input required type="search" class="global-searchbar" placeholder="Search" name="q">
-         <!---<button type="submit" class="global-search_submit"><i class="ri-search-line"></i></button>--->
       </form>
 
    </nav>

data/_layouts/entry.html

@@ -0,0 +1,11 @@
+---
+   layout: default
+---
+
+<nav class="entry-index">
+
+</nav>
+
+{{ content }}
+
+<script src="/assets/js/toc.js"></script>

data/_layouts/grammar.html

@@ -1,11 +1,7 @@
 ---
-   layout: default
+   layout: entry
 ---
 
-<nav class="entry-index">
-
-</nav>
-
 <article class="entry entry-grammar">
 
    <h1>{{ page.title }}</h1>
@@ -13,5 +9,3 @@
    {{ content }}
 
 </article>
-
-<script src="/assets/js/toc.js"></script>

data/_layouts/launchpad.html

@@ -1,3 +1,63 @@
 ---
    layout: default
 ---
+
+<div class="launchpad">
+
+
+
+   <section class="launchpad-search">
+
+      <form action="/search" method="GET">
+
+         <label for="input__text">What do you want to know?</label><br>
+         <input id="input__text" name="q" class="launchpad-searchbar" required type="search" placeholder="Search">
+
+         <input type="submit" class="launchpad-search_submit" value="Go">
+
+      </form>
+
+   </section>
+
+
+
+   <section class="launchpad-projects">
+
+      {% if site.multi_projects %}
+
+         {% for item in site.data.projects %}
+
+            <a href="{{ item.link }}" class="launchpad-card">
+               <i class="{{ item.icon }} project-icon"></i>
+               <header>{{ item.name }}</header>
+               {{ item.desc }}
+            </a>
+
+         {% endfor %}
+
+      {% else %}
+
+         <a href="/wiki" class="launchpad-card launchpad-card_wiki">
+            <i class="ri-footprint-line project-icon"></i>
+            <header>Explore the wiki!</header>
+         </a>
+
+         <a href="/wiki:contents" class="launchpad-card">
+            <i class="ri-file-list-2-line project-icon"></i>
+            <header>Contents</header>
+            Navigate the wiki
+         </a>
+
+         <a href="/wiki:random" class="launchpad-card">
+            <i class="ri-question-line project-icon"></i>
+            <header>Random</header>
+            Visit a random article
+         </a>
+
+      {% endif %}
+
+   </section>
+
+
+
+</div>

data/_layouts/reference_desk.html

@@ -2,25 +2,30 @@
    layout: collections
 ---
 
+{% include collections_header.html %}
+
+
 <section class="reference-desk">
 
-   {% if page.url == "/wiki" %}
       <header class="collections-portals">
-         <h1 class="collections-portals_header">Pick a topic</h1>
          <nav class="collections-portals_grid">
 
-            {% for item in site.data.portals_wiki %}
-               <a href="{{ item.link }}" class="collections-portal_card">
-                  <header>
-                     <i class="{{ item.icon }} portal-icon"></i>
-                     {{ item.name }}
-                  </header>
-                  {{ item.summary }}
-               </a>
+            {% 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>
-   {% endif %}
 
    <section class="collections-wrapper">
 

data/_layouts/wiki.html

@@ -1,51 +1,81 @@
 ---
-   layout: default
+   layout: entry
 ---
 
-<nav class="entry-index">
+<article class="entry entry-wiki">
 
-</nav>
 
-<article class="entry entry-wiki">
 
    <h1>
       {{ page.title }}
    </h1>
 
-   <section class="entry-tags">
-      <ul>
-         <ul>
-            <li>Portals:</li>
-            <li><a href="/wiki/portal:{{ page.portal }}">{{ page.portal }}</a></li>
-         </ul>
+
+
+   {% if page.other_projects %}
+
+      <section class="entry-other_projects">
+         View in other collections:
          <ul>
-            <li>Categories:</li>
-            {% for item in page.categories %}
+            {% for item in page.other_projects %}
                <li>
-                  <a href="/wiki/category:{{ item | slugify }}">
-                     {{ item }}
-                  </a>
+                  <a href="/{{ item }}{{ page.url | remove_first: "/wiki" }}">{{ item | capitalize }}</a>
                </li>
             {% endfor %}
          </ul>
-         <ul>
-            <li>Tags:</li>
+      </section>
+
+   {% endif %}
+
+
+
+   <section class="entry-tags">
+
+      <div class="entry-subhead_pair">
+
+         <span class="entry-subhead_key">Portals:</span>
+         <span>
+            <a href="/wiki/portal:{{ page.portal }} class="entry-subhead_value"">
+               {{ page.portal }}
+            </a>
+         </span>
+
+      </div>
+
+      <div class="entry-subhead_pair">
+
+         <span class="entry-subhead_key">Categories:</span>
+         <span>
+            {% for item in page.categories %}
+               <a href="/wiki/category:{{ item | slugify }}" class="entry-subhead_value">
+                  {{ item }}
+               </a>
+            {% endfor %}
+         </span>
+
+      </div>
+
+      <div class="entry-subhead_pair">
+
+         <span class="entry-subhead_key">Tags:</span>
+         <span>
             {% for item in page.tags %}
-               <li>
-                  <a href="/wiki/tag:{{ item | slugify }}">
-                     {{ item }}
-                  </a>
-               </li>
+               <a href="/wiki/tag:{{ item }}" class="entry-subhead_value">
+                  {{ item }}
+               </a>
             {% endfor %}
-            </li>
-         </ul>
-      </ul>
+         </span>
+
+      </div>
+
    </section>
 
    {{ content }}
 
 </article>
 
+
+
 {% if page.quickstats %}
 
    <section class="entry-quickstats">
@@ -92,5 +122,3 @@
    </section>
 
 {% endif %}
-
-<script src="/assets/js/toc.js"></script>

data/_layouts/work.html

@@ -1,11 +1,7 @@
 ---
-   layout: default
+   layout: entry
 ---
 
-<nav class="entry-index">
-
-</nav>
-
 <article class="entry entry-work">
 
    <h1>{{ page.title }}</h1>
@@ -13,5 +9,3 @@
    {{ content }}
 
 </article>
-
-<script src="/assets/js/toc.js"></script>

data/_pages/random.html

@@ -0,0 +1,41 @@
+---
+   # Jekyll page that redirects to a random page, post or document
+   # https://github.com/jekylltools/jekyll-random-redirect
+   # v1.6
+   permalink: /random
+---
+
+{%- assign docs = site.posts -%}
+
+{%- if site.random_redirect.pages == true -%}
+  {%- assign pages = site.documents | where_exp:"page","page.url != '/random/'" -%}
+  {%- assign docs = docs | concat: pages -%}
+{%- endif -%}
+
+{%- if site.random_redirect.documents == true -%}
+  {%- assign docs = docs | concat: site.documents | uniq -%}
+{%- endif -%}
+
+   <script type="text/javascript">
+      var urls=[];
+
+      {% for doc in docs -%}
+         urls.push("{{ doc.url | absolute_url }}");
+      {% endfor -%}
+
+      var url = urls[Math.floor(Math.random()*urls.length)];
+      var link = document.createElement('link');
+      link.setAttribute('rel', 'canonical');
+      link.setAttribute('href', url);
+      document.head.appendChild(link);
+
+      if (typeof IE_fix != "undefined") {
+         document.write("Redirecting...");
+         var referLink = document.createElement("a");
+         referLink.href = url;
+         document.body.appendChild(referLink);
+         referLink.click();
+      } else {
+         window.location.replace(url);
+      }
+   </script>

data/_pages/search.md

@@ -9,7 +9,7 @@
 
 <script>
    window.pages = {
-      {% for page in site.wiki %}
+      {% for page in site.documents %}
          "{{ page.url | slugify }}": {
             "title": "{{ page.title | xml_escape }}",
             "content": {{ page.content | markdownify | strip_newlines | strip_html | jsonify }},
@@ -20,5 +20,6 @@
    };
 </script>
 
+
 <script src="/assets/js/lunr.js"></script>
 <script src="/assets/js/search.js"></script>

data/_pages/wiki/wiki.md

@@ -0,0 +1,4 @@
+---
+   layout: reference_desk
+   permalink: /wiki
+---

data/_pages/{wiki.md → wiki/wiki_all.md}

@@ -1,7 +1,7 @@
 ---
    layout: collections
    title: All wiki articles
-   permalink: /wiki
+   permalink: /wiki:all
 ---
 
 <ul class="collections_list">

data/_pages/wiki/wiki_contents.md

@@ -0,0 +1,19 @@
+---
+   layout: collections
+   title: Wiki contents
+   permalink: /wiki:contents
+---
+
+The information in this wiki is organized into the following subject portals. Each portal broadly surveys  and is further organized into various levels of subcategories.
+
+{% for item in site.data.portals_wiki %}
+   <dl class="">
+      <dd><a href="{{ item.link }}">{{ item.name }}</a></dd>
+      <dt>{{ item.contents }}</dt>
+   </dl>
+{% endfor %}
+
+## Special categories
+
++ Timelines
++ Glossaries

data/_pages/wiki/wiki_random.md

@@ -0,0 +1,41 @@
+---
+   # Jekyll page that redirects to a random page, post or document
+   # https://github.com/jekylltools/jekyll-random-redirect
+   # v1.6
+   permalink: /wiki:random
+---
+
+{%- assign docs = site.posts -%}
+
+{%- if site.random_redirect.pages == true -%}
+  {%- assign pages = site.wiki | where_exp:"page","page.url != '/random/'" -%}
+  {%- assign docs = docs | concat: pages -%}
+{%- endif -%}
+
+{%- if site.random_redirect.documents == true -%}
+  {%- assign docs = docs | concat: site.documents | uniq -%}
+{%- endif -%}
+
+   <script type="text/javascript">
+      var urls=[];
+
+      {% for doc in docs -%}
+         urls.push("{{ doc.url | absolute_url }}");
+      {% endfor -%}
+
+      var url = urls[Math.floor(Math.random()*urls.length)];
+      var link = document.createElement('link');
+      link.setAttribute('rel', 'canonical');
+      link.setAttribute('href', url);
+      document.head.appendChild(link);
+
+      if (typeof IE_fix != "undefined") {
+         document.write("Redirecting...");
+         var referLink = document.createElement("a");
+         referLink.href = url;
+         document.body.appendChild(referLink);
+         referLink.click();
+      } else {
+         window.location.replace(url);
+      }
+   </script>