jekyll-theme-paperwiki 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1896b6de7d51495d6bdf12f3cc9aac56bb2573fcf80ce429725fee3593762b91
-  data.tar.gz: 18e1e6d0a06dffaff1f3ab69f29464186573086d0ade1df15cea4b45085cf568
+  metadata.gz: ccafbae2594b3e26ca40574057a535540860cdfab82ad62d47cbeed13ccc3427
+  data.tar.gz: ef2323e18fe4d2f3819459bcfb0866ed38366c1d92da8cd010f48e2fbd266180
 SHA512:
-  metadata.gz: 894e88cf0db6b281bd2ab322009df722df6859da06b9e6471c8088ebb80e4e500ef58b6ea6bc78e8a0d3d5eac35c92a5f22147de733c255e00fb9e17f42b1947
-  data.tar.gz: daa223a3bea9974c308e1fa6c726fee01e64d494586f827ef30d58c7d964ce8c24c0a523acb4969bc4cb5e1054d0eb397c2f8970ed2f1ef9ede4b63e910672de
+  metadata.gz: c31c58b6e6a115360b9561cec521815ba98036eeb37d0fcf0873808f29b8e6563ebfa9ef4d56e171c67c377d89b7d195612eb03088c3bde1d8eb77584f4735bc
+  data.tar.gz: 8b540673b1a01905b6259c47c73677737cb76373f3e20526896b724a8c2c858a66777b5239ecd3576deb85df2113cb33ce94b06c85e62ead2904cf0a88fecfc8

data/README.md

@@ -1,38 +1,21 @@
 # jekyll-theme-paperwiki
 
-![](/assets/images/homepage.png)
+![A screenshot of the PaperWiki homepage.](/assets/images/homepage.png)
 
 For storing your worldbuilding notes! 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.
 
 For the easiest starting point, I have uploaded a [sample site](https://github.com/pomeloshark/paperwiki-example) that you can download with everything preconfigured, so if you're unfamiliar with Jekyll you can bypass all the setup and get right to it. See that repo for instructions.
 
-I've tried to adhere to accessible and easy to read design principles while retaining the look and layout of a classic wiki that we're all familiar with - I've aped some elements of Wikipedia's organizational system and layout while trying to make it as clean and user friendly as possible.
-
-This theme is not mobile friendly, as I personally do absolutely no work on mobile and thus my development skills are lacking. I stuck in a couple CSS breakpoints, so it'll be mostly legible on a medium-sized tablet, but don't expect great results on a phone. There is also no dark mode or other alternate colour scheme, but please feel free to fork this project and add whatever functionality you're looking for.
-
 This theme is not really intended for blogging, but you could add in the functionality easily enough by creating a `_posts` collection and setting a default post layout in the config file, as there is a dedicated `post` layout, as well as a `blog.md` which will list all of your blog posts on one page. If you have no need for it you can delete this file.
 
 
 
-## Usage
-
-In case you're unfamiliar with it, a basic Jekyll site includes the following:
-+ The `_includes` folder contains snippets of HTML that are frequently reused on pages throughout the website. This saves us from having to copy and paste the HTML on multiple pages, and we only have to edit it in one file in order to change every instance of it.
-+ The `_layouts` folder contains the formatting for different types of pages, meaning that instead of formatting each page individually we can just specify which layout template to use.
-+ The `_sass` folder contains all the styling for the site, written in SCSS.
-+ The `_site` folder contains everything that Jekyll outputs when it builds the site. Don't edit anything in this folder, as it will be rewritten the next time you serve the site.
-+ The `assets` folder contains things like fonts, images, and Javascript files. It also contains a `.scss` file importing all of your SCSS so that Jekyll can convert it to regular CSS.
-
-This theme comes with all of these prepackaged, so most of what you have to do is edit the `_config.yaml` file. The theme has some default config set already, but you can override these in your own config file if you wish. You can also add any of the above folders to your own project with includes, layouts, or SCSS to override the theme's files. For example, you will want to add your own `assets` folder to store your own images, including one titled `favicon.png` in order to override the placeholder one i've included.
-
-
-
 ## Installation
 
 [Install Jekyll](https://jekyllrb.com/docs/). If you're using the example site linked above, you can skip ahead to the [using the wiki](#using-the-wiki) section. Otherwise, create a new site by running the following in your terminal:
 
 ```
-$ jekyll new MYSITENAME
+jekyll new SITE_NAME_HERE
 ```
 
 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:
@@ -90,26 +73,7 @@ Navigate to your localhost and...you will see an empty page. This is because the
 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.
-
-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
-- You may need to specify a permalink and a title if you want to use certain characters that are not allowed in filenames -- say, some IPA characters. Otherwise just title your articles "Article title.md", with spaces, not underscores or hyphens, and the default settings will take care of the rest.
-
-If you're unfamiliar with Markdown, see [here](https://www.markdownguide.org/).
+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. See my [guide](https://pomeloshark.github.io/jekyll) for further details.
 
 
 

data/_layouts/grammar.html

@@ -0,0 +1,25 @@
+---
+   layout: entry
+---
+
+<article class="entry entry_grammar">
+
+   <h1>
+      {{ page.name | remove: ".md" }}
+   </h1>
+
+   {% if site.entry_tags_top %}
+      <section class="entry-tags entry-tags_top">
+         {% include entry_tags.html %}
+      </section>
+   {% endif %}
+
+   {{ content }}
+
+   {% if site.entry_tags_top == false %}
+      <section class="entry-tags entry-tags_bottom">
+         {% include entry_tags.html %}
+      </section>
+   {% endif %}
+
+</article>

data/_layouts/random.html

@@ -16,6 +16,8 @@
   {%- assign docs = docs | concat: site.documents | uniq -%}
 {%- endif -%}
 
+<!---Fix this so the collections random links are scoped to only that collection--->
+
    <script type="text/javascript">
 
       var urls=[];

data/_layouts/work.html

@@ -0,0 +1,27 @@
+---
+   layout: entry
+---
+
+<article class="entry entry_work">
+
+   <h1>
+      {{ page.name | remove: ".md" }}
+   </h1>
+
+   {% if site.entry_tags_top %}
+      <section class="entry-tags entry-tags_top">
+         {% include entry_tags.html %}
+      </section>
+   {% endif %}
+
+   {{ content }}
+
+   {% if site.entry_tags_top == false %}
+      <section class="entry-tags entry-tags_bottom">
+         {% include entry_tags.html %}
+      </section>
+   {% endif %}
+
+</article>
+
+{% include wiki_sidebar.html %}

data/_sass/partials/_search.scss

@@ -14,7 +14,10 @@
    margin-left: 0;
 }
 
-.search_result {}
+.search_result {
+   text-decoration: none;
+   font-weight: bold;
+}
 
 .search_result-details {
    margin-bottom: 0;
@@ -26,3 +29,10 @@
 .search_result-preview {
    margin-bottom: 1.75rem;
 }
+
+.search_result-highlight {
+   padding: 0.2em 0.3em;
+
+   background-color: $color-peach;
+   border-radius: $border_radius-inline;
+}

data/assets/js/search.js

@@ -1,13 +1,16 @@
-// Yoinked in its entirety from https://davidwalsh.name/adding-search-to-your-site-with-javascript
+// Yoinked in its entirety from https://davidwalsh.name/adding-search-to-your-site-with-javascript and https://trackjs.com/blog/site-search-with-javascript-part-2/
 
+// var lunrFolding = require("lunr-folding")(lunr);
+
+// Build the search index
 var searchIndex = lunr(function() {
-   // define searchable fields for each page
+   // Define searchable fields for each page
    this.ref("id");
-   this.field("title", { boost: 10 });
-   this.field("content");
+   this.field("title", { boost: 100 }); // Boost the importance of the title field, prioritizing title matches
+   this.field("content", { boost: 10 });
    this.field("portal");
    this.field("categories");
-   for (var key in window.pages) {
+   for (var key in window.pages) { // Loop through all pages to add their data to the search index
       this.add({
          "id": key,
          "title": pages[key].title,
@@ -30,21 +33,44 @@ function getQueryVariable(variable) {
 }
 
 var searchTerm = getQueryVariable("q");
-// creation of searchIndex from earlier example
-var results = searchIndex.search(searchTerm);
+// Create index of search term matches
+var results = searchIndex.search(searchTerm + "*"); // Wildcard by default
 var resultPages = results.map(function (match) {
    return pages[match.ref];
 });
 
 
 
+// Text highlighting
+function formatContent(content, searchTerm) {
+    var termIdx = content.toLowerCase().indexOf(searchTerm.toLowerCase());
+    if (termIdx >= 0) {
+        var startIdx = Math.max(0, termIdx - 140);
+        var endIdx = Math.min(content.length, termIdx + searchTerm.length + 140);
+        var trimmedContent = (startIdx === 0) ? "" : "…";
+        trimmedContent += content.substring(startIdx, endIdx);
+        trimmedContent += (endIdx >= content.length) ? "" : "…"
+
+        var highlightedContent = trimmedContent.replace(new RegExp(searchTerm, "ig"), function matcher(match) {
+            return "<mark class='search_result-highlight'>" + match + "</mark>";
+        });
+
+        return highlightedContent;
+    }
+    else {
+        var emptyTrimmedString = content.substr(0, 280);
+        emptyTrimmedString += (content.length < 280) ? "" : "&hellip;";
+        return emptyTrimmedString;
+    }
+}
+
+
 
-// resultPages from previous example
 resultsString = "";
-resultPages.forEach(function (r) {
+resultPages.forEach(function (r) { // Format the output on the search results page
    resultsString += "<dt class='search_result'>";
-   resultsString += "<a href='" + r.url + "'>" + r.title + "</a>";
+   resultsString += "<a class='search_result' href='" + r.url + "'>" + r.title + "</a>";
    resultsString += "<span class='search_result-details'>" + r.portal + " ⋅ " + r.categories + "</span></dt>"
-   resultsString += "<dd class='search_result-preview'>" + r.content.substring(0, 200) + "..." + "</dd>";
+   resultsString += "<dd class='search_result-preview'>" + formatContent(r.content, searchTerm) + "" + "</dd>";
 });
 document.querySelector("#search-results").innerHTML = resultsString;

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-paperwiki
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - pomeloshark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '0'
 description:
 email:
 executables: []
@@ -44,6 +44,7 @@ files:
 - _layouts/collections.html
 - _layouts/default.html
 - _layouts/entry.html
+- _layouts/grammar.html
 - _layouts/launchpad.html
 - _layouts/page.html
 - _layouts/portal.html
@@ -53,6 +54,7 @@ files:
 - _layouts/search.html
 - _layouts/search_global.html
 - _layouts/wiki.html
+- _layouts/work.html
 - _sass/partials/_base.scss
 - _sass/partials/_blog.scss
 - _sass/partials/_collections.scss
@@ -100,7 +102,6 @@ files:
 - assets/fonts/RemixIcon/remixicon.css
 - assets/fonts/RemixIcon/remixicon.eot
 - assets/fonts/RemixIcon/remixicon.glyph.json
-- assets/fonts/RemixIcon/remixicon.less
 - assets/fonts/RemixIcon/remixicon.svg
 - assets/fonts/RemixIcon/remixicon.symbol.svg
 - assets/fonts/RemixIcon/remixicon.ttf
@@ -2404,5 +2405,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: A theme meant for use as a personal wiki.
+summary: A Jekyll theme meant for use as a personal wiki.
 test_files: []