hematite 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c0b3ae9bdec4a2e37d649a52dfbacb84a8c09b258d2a5bb676571c5fed060d
-  data.tar.gz: '09bc9aa4956973f5cbb3dfa1e4889b9adfe70928eb5f2f25518b09b863a4e8ed'
+  metadata.gz: 05a0aa60a85dd027a9a75e119e54432b2ea0657775d872ae3b0474e9ebab9a5a
+  data.tar.gz: 2d93683789b2ecff19bcc54608484e64889488a151f3f668596d3df79a5fcf90
 SHA512:
-  metadata.gz: 86065a34d00cc7d8844bdd02883dc7c8dd25c4c6436a1d4b28747d0140d4409d0ac7e7a910d8fe4f54ba546c303208cb347d598141a6e66b1d0c5607e282f249
-  data.tar.gz: 2b218f88fec888c6029650fdd29b0809729cd321905e25e9151e26173347e7488813eebcc79d32c7ced657d8a4ce7a0e2acb4b9386e9d683607b6622e6911784
+  metadata.gz: 51770f1f5812dae37c4ff1eaf87c36f799cbb5ed73dbb45bb16cb3517dc34bf3d305c6d2a54fe4baeb2f6e4c623e6e271b7db9b2cdb60b078c326a88b97ce11b
+  data.tar.gz: ab0ccb98a0ab44a07d6e1d86c32ef42ab68f3bf0ec1fb626ca53a913c4d4c00fd0602c9373dbfac64af0b7b98b684dd4be523dd6d91fc51825422b8571bd3aeb

data/_includes/extern_library_imports.html

@@ -8,4 +8,40 @@
 
 <!-- Page/site-specific imports and configuration -->
 {{ site.additional_import_html | default: "" }}
+{{ layout.additional_import_html | default: "" }}
 {{ page.additional_import_html | default: "" }}
+
+{% comment %}
+Each [spec]=["key", { property: value, property2: value2, ... }]
+{% endcomment %}
+{% for spec in layout.additional_imports | concat: page.additional_imports %}
+    {% assign target = spec[1] %}
+    {% if target.type == 'js' or target.type == 'mjs' %}
+        {% assign tag="script" %}
+        {% assign url_spec = "src" %}
+        {% assign options = "" %}
+    {% else %}
+        {% assign tag="link" %}
+        {% assign options = "rel='stylesheet'" %}
+        {% assign url_spec = "href" %}
+    {% endif %}
+
+    {% if target.type == 'mjs' %}
+        {% assign options = "type = 'module'" %}
+    {% endif %}
+
+    {% if target.absolute_url %}
+        {% assign url = target.absolute_url %}
+    {% else %}
+        {% assign url = target.url | relative_url %}
+    {% endif %}
+
+    {% if target.context and target.context != include.context %}
+    {% else %}
+    <{{ tag }} {{ options }}
+        {{ target.inline_options | default: "" }}
+        {{url_spec}}={{ url | jsonify }}
+        onload={{ target.onload | default: "" | jsonify }}></{{tag}}>
+    {% endif %}
+{% endfor %}
+

data/_includes/katex_includes.html

@@ -4,7 +4,7 @@
     KaTeX can be enabled with page.katex.
 -->
 
-{% if page.katex || site.mermaid %}
+{% if page.katex or layout.katex or site.mermaid %}
 
 <!-- See the releases tab on https://github.com/KaTeX/KaTeX  -->
 <link

data/_includes/mermaid_includes.html

@@ -2,7 +2,7 @@
 <!--
     Include mermaid-js scripts.
 -->
-{% if page.mermaid || site.mermaid %}
+{% if page.mermaid or site.mermaid or layout.mermaid %}
 <script>
     var MERMAID_CONFIG = window.MERMAID_CONFIG ?? {{ site.mermaid_config | jsonify }} ?? { };
 

data/_layouts/example_custom_remark_slideshow.html

@@ -0,0 +1,47 @@
+---
+layout: remark_slideshow
+additional_imports:
+    katex:
+        type: js
+        url: /assets/plugin/katex/katex.min.js
+        context: remark_frame
+        comment: >-
+            Setting context to remark_frame means to only run this
+            in the remark-specific iframe.
+    katex_auto_init_math:
+        type: js
+        url: /assets/plugin/katex/contrib/auto-render.min.js
+        onload: renderMathInElement(document.body)
+        inline_options: defer
+        comment: >-
+            We're passing 'defer' above because we want this script to load
+            _after_ the body.
+    katex_css:
+        type: css
+        url: /assets/plugin/katex/katex.min.css
+
+remark_presentation_config:
+    navigation:
+        scroll: false
+    slideNumberFormat: "Slide %current% of %total%."
+
+mermaid: true
+remark_presentation_config_html: >-
+    Testing... This should be included at the top of the file.
+---
+
+{% comment %}
+This template is an example of how to customize remark slideshows
+by creating a new template.
+
+`additional_imports` can be used on any page. In this case, the imports
+are included both in the remark presentation `iframe` and in the main page.
+
+Of course, we could include `katex` or `mermaid` here by setting `katex: true`
+or `mermaid: true` in the header`, but `additional_imports` is another way to
+specify this.
+
+Note that `remark_presentation_config` is passed directly to remark.
+{% endcomment %}
+
+{{ content }}

data/_layouts/remark_slideshow.html

@@ -3,9 +3,13 @@ layout: default
 ---
 
 <!-- Defines a https://remarkjs.com/ slideshow -->
-<!-- Configure remark with
+<!--
+    Configure remark with
     page.remark_presentation_config, site.remark_presentation_config,
     page.remark_presentation_config_html
+
+    Note: Jekyll's default parser must not parse the input markdown file.
+    Either use a non-md extension or wrap its content in a <div markdown=false>...</div>
 -->
 
 {% assign frame_resource_url = 'assets/html/remark_presentation_frame.html.resource' | relative_url %}
@@ -16,23 +20,54 @@ layout: default
             onload="window.presentationFrameLoaded = true;"></iframe>
 </main>
 
+<!--
+    Liquid (sometimes?) does not handle unicode (e.g. π) characters properly when using
+    url_encode (or at least not consistently with JS's unescape), so include
+    content directly:
+-->
+<textarea id="source" style="display: none;">
+{{content}}
+</textarea>
+
 <script defer type="module">
+    // Matches <div>...</div> or <div markdown=0>...</div>
+    // Jekyll can remove the 'markdown=0' while parsing.
+    const WRAPPING_DIV_EXP = /\s*[<]div.*[>]((?:.|[\n\r])*)[<]\/div[>]\s*/;
+
     import slideshow from "{{ 'assets/js/layout/remark_slideshow.mjs' | relative_url }}";
 
     let presentationFrame = document.querySelector("#presentation_frame");
     presentationFrame.src = {{ frame_resource_url | jsonify }};
     window.presentationFrameLoaded = false;
 
-    let config =
-        {{ page.remark_presentation_config | default: site.remark_presentation_config | jsonify }};
-    config ??= {};
 
-    config.source = {{ page.content | jsonify }};
+    let siteConfig = {{ site.remark_presentation_config | jsonify }} ?? {};
+    let layoutConfig = {{ layout.remark_presentation_config | jsonify }} ?? {};
+    let pageConfig = {{ page.remark_presentation_config | jsonify }} ?? {};
+    let config = {};
+
+    // Merge the remark configurations. siteConfig has highest precedence.
+    for (let currentConfig of [siteConfig, layoutConfig, pageConfig]) {
+        for (let key in currentConfig) {
+            config[key] = currentConfig[key];
+        }
+    }
+
+    // Escape the content to prevent liquid from rendering it.
+    config.source = document.querySelector("#source").value;
+
+    // Unwrap if surrounded by markdown-parser-disabling HTML
+    let markdownDisableMatches = config.source.match(WRAPPING_DIV_EXP);
+
+    // Replace with first capture (contents of the wrapping element).
+    if (markdownDisableMatches && markdownDisableMatches.length > 0) {
+        config.source = markdownDisableMatches[1];
+    }
 
     // Library imports intended for this page: Forward to the frame.
     let libraryImports = unescape(`
         {% capture library_imports %}
-            {% include extern_library_imports.html %}
+            {% include extern_library_imports.html context='remark_frame' %}
         {% endcapture %}
         {{ library_imports | url_encode | replace: "+", " " }}
     `);
@@ -55,7 +90,14 @@ layout: default
 
         // Any additional configuration scripts/html specific to remark
         presentationDoc.write(unescape(
-            {{ page.remark_presentation_config_html | default: "" | url_encode | replace: "+", " " | jsonify }}
+            {{
+                page.remark_presentation_config_html | default: site.remark_presentation_config_html | default: "" | url_encode | replace: "+", " " | jsonify
+            }}
+        ));
+
+        // If another layout extends this layout,
+        presentationDoc.write(unescape(
+            {{ layout.remark_presentation_config_html | default: "" | url_encode | replace: "+", " " | jsonify }}
         ));
 
         presentationDoc.write(`
@@ -67,8 +109,8 @@ layout: default
             }
             </${"script"}>
         `);
-        presentationDoc.close();
-        (async () => {
+
+        presentationWin.initPresentation = (async () => {
             await slideshow.start(presentationFrame.contentWindow, config);
 
             // Ensure that mermaid has already been run!
@@ -76,7 +118,14 @@ layout: default
                 presentationWin.mermaid.init();
                 console.log("Ran mermaid!");
             }
-        })();
+        });
+
+        presentationDoc.write(`
+            <${"script"}>
+                window.initPresentation();
+            </${"script"}>
+        `);
+        presentationDoc.close();
     };
 
     if (window.presentationFrameLoaded) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hematite
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Henry Heino
@@ -48,6 +48,7 @@ files:
 - _includes/settings.html
 - _layouts/calendar.html
 - _layouts/default.html
+- _layouts/example_custom_remark_slideshow.html
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html