jekyll-theme-paperwiki 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 537ec88608639efc7b930c4eacc4763b95cfd9afcf252d0e29bcb382032814ac
-  data.tar.gz: c5775b9cbf924df74540b1024700ebf47f827342d4b310bbf97ca65518ed5e59
+  metadata.gz: dd9bd7015a5fd9b6b1ea1139ce529d52c0d769b96585cc00800a3bf1db28d571
+  data.tar.gz: 358584149a0141a2f73b19565ae0a17a3a8d233fac4d153788a59b105148bf45
 SHA512:
-  metadata.gz: 496115be9955cc434f57331c3f3afb2e6259310253a3b81be7881a0af5bc332b50d49471420fd7e11ee1a3b1f73f9e23356ea40d706b98bcaabfbc8e0bd5d001
-  data.tar.gz: 86f7cb061499a6c94431b816775d4ad1ced49a2f99f8bb6ca6d5dd7c0f5cc9340f4c87077e7c2e6a3b1b7b6fb168105525872adcd0fb751eab8c4be285d7d8bf
+  metadata.gz: '0900591839357e2f3ef3059d75b50dec0ed9b6863248eb69a80bbc4d77ab4d9a0d156fe1fe0e0e701f4256aa77b4a69452de5e4cf13f2f40c3d7f60feda38bf7'
+  data.tar.gz: 76c2dc278a7d1a4f33f0faf737ce1a2116538273d8108ede6da2b612b74b3fc5a5d670a5370ff0e1d344113c9a34c4810a816fd2bcf6d3ba7e9c320c636fa7e3

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.
 
 
 
@@ -25,12 +27,31 @@ This theme comes with all of these prepackaged, so most of what you have to do i
 $ 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 will want to add a folder called `collections`, and inside of that another folder called `_wiki`.
+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
+```
+
+(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`:
@@ -57,7 +78,15 @@ To serve your site locally, navigate into the site's directory and run:
 $ bundle exec jekyll serve
 ```
 
-Navigate to your localhost and voila! Start adding articles in your wiki collections folder.
+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:
 
@@ -66,7 +95,10 @@ All of your wiki pages should be written in markdown, and you must begin each `.
 ---
 ```
 
-Between these two lines is where you would include *front matter*, such as specifying the layout or the permalink to the page. Jekyll needs to know that the front matter is there in order to output 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.
+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.
+
+Caveats:
+- if the site won't build due to an error with the random page, make sure you have more than one wiki article for it to draw from
 
 ​
 
@@ -92,7 +124,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`:
 
@@ -100,7 +132,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
 
 
 

data/_config.yml

@@ -1,55 +1,13 @@
-# 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 }}.
 
-# Build settings
-
-# 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/
+random_redirect:
+   pages: true
 
-#
 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-paperwiki
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - pomeloshark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -26,7 +26,6 @@ dependencies:
         version: '4.2'
 description:
 email:
-- pomeloshark@proton.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -51,12 +50,6 @@ files:
 - _layouts/reference_desk.html
 - _layouts/wiki.html
 - _layouts/work.html
-- _pages/random.html
-- _pages/search.md
-- _plugins/gloss.rb
-- _plugins/interlinear.rb
-- _plugins/ipa.rb
-- _plugins/lang.rb
 - _sass/partials/_base.scss
 - _sass/partials/_blog.scss
 - _sass/partials/_collections.scss
@@ -70,7 +63,6 @@ files:
 - _sass/variables/_colors.scss
 - _sass/variables/_fonts.scss
 - assets/css/style.scss
-- assets/fonts/.DS_Store
 - assets/fonts/Inter/.DS_Store
 - assets/fonts/Inter/Inter-Bold.otf
 - assets/fonts/Inter/Inter-Bold.woff
@@ -108,8 +100,6 @@ files:
 - assets/fonts/RemixIcon/remixicon.woff
 - assets/fonts/RemixIcon/remixicon.woff2
 - assets/images/favicon.png
-- assets/images/wiki1.png
-- assets/images/wiki2.png
 - assets/js/lunr.js
 - assets/js/search.js
 - assets/js/toc.js

data/_pages/random.html

@@ -1,41 +0,0 @@
----
-   # 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

@@ -1,25 +0,0 @@
----
-   permalink: /search
-   title: Search results
----
-
-<h1>{{ page.title }}</h1>
-
-<dl id="search-results"></dl>
-
-<script>
-   window.pages = {
-      {% for page in site.documents %}
-         "{{ page.url | slugify }}": {
-            "title": "{{ page.title | xml_escape }}",
-            "content": {{ page.content | markdownify | strip_newlines | strip_html | jsonify }},
-            "url": "{{ site.url | append: page.url | xml_escape }}",
-            "path": "{{ page.url | xml_escape }}"
-         }{% unless forloop.last %},{% endunless %}
-      {% endfor %}
-   };
-</script>
-
-
-<script src="/assets/js/lunr.js"></script>
-<script src="/assets/js/search.js"></script>

data/_plugins/gloss.rb

@@ -1,22 +0,0 @@
-module Jekyll
-   module InterlinearGlossFilter # Liquid just uses the method name as the filter name; there's no extra level of name-mapping like there is with tags and blocks
-
-      def gloss(input) # will be available as the "gloss" filter
-         @text = input
-#         puts "<tr>"
-
-#         lexemes = @text.split(" ")
-#         lexemes.each do |word|
-#            puts "<td class=\"gloss_item\">#{word}</td>"
-#         end
-
-#         puts "</tr>"
-
-#         morphemic_analysis
-#         morphemic_gloss
-
-      end
-   end
-end
-
-Liquid::Template.register_filter(Jekyll::InterlinearGlossFilter)

data/_plugins/interlinear.rb

@@ -1,24 +0,0 @@
-module Jekyll
-   module Tags
-      class InterlinearGlossTag < Liquid::Block
-
-         require "shellwords"
-
-         # initialize is called when we encounter the {% interlinear %} Liquid tag; 'interlinear' is the tag name and anything immediately after it is passed in via the second argument
-         def initialize(tag_name, text, tokens)
-            super
-#            @text = text.shellsplit
-#            @wordcount = @text[0].length
-            # object_lang, morphemic_analysis, morphemic_gloss, target_lang
-         end
-
-         def render(context)
-#            "<table class=\"interlinear-gloss\"><tbody><tr><td colspan=\"7\">#{@text[0]}</td></tr>" + "<tr><td>#{@text[1]}</td></tr></tbody></table>"
-         end
-
-      end
-   end
-end
-
-# The register_tag method takes two arguments: the user-facing name of the tag [interlinear], and the class that implements it [InterlinearGlossTag].
-Liquid::Template.register_tag('interlinear', Jekyll::Tags::InterlinearGlossTag)

data/_plugins/ipa.rb

@@ -1,19 +0,0 @@
-module Jekyll
-   module Tags
-      class RenderPhoneticTag < Liquid::Tag
-
-         def initialize(tag_name, text, tokens)
-            super
-            @text = text
-         end
-
-         def render(context)
-            "<abbr class=\"gloss\" title=\"International Phonetic Alphabet\">IPA</abbr>: <span class=\"ipa\">#{@text}</span>"
-         end
-
-      end
-   end
-end
-
-# The register_tag method takes two arguments: the user-facing name of the tag [lang], and the class that implements it [DefineLanguageTag].
-Liquid::Template.register_tag("ipa", Jekyll::Tags::RenderPhoneticTag)

data/_plugins/lang.rb

@@ -1,27 +0,0 @@
-# usage: {% lang text[0] text[1]     text[2] %}
-# usage: {% lang ko      바이 괕 모    iced jelly dish %}
-# text[0] = language code
-# text[1] = the text, in latin script or not
-# text[2] = the translation into english
-
-module Jekyll
-   module Tags
-      class DefineLanguageTag < Liquid::Tag
-
-         require "shellwords"
-
-         def initialize(tag_name, text, tokens)
-            super
-            @text = text.shellsplit
-         end
-
-         def render(context)
-            "<abbr class=\"gloss\" title=\"#{@text[0]}\">#{@text[0]}</abbr>: <strong>#{@text[1]}</strong> <em>#{@text[2]}</em>"
-         end
-
-      end
-   end
-end
-
-# The register_tag method takes two arguments: the user-facing name of the tag [lang], and the class that implements it [DefineLanguageTag].
-Liquid::Template.register_tag('lang', Jekyll::Tags::DefineLanguageTag)