al_folio_distill 1.0.0

data/lib/al_folio_distill/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AlFolioDistill
+  VERSION = "1.0.0"
+end

data/lib/al_folio_distill.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "al_folio_distill/version"
+
+module AlFolioDistill
+  PLUGIN_ROOT = File.expand_path("..", __dir__)
+  TEMPLATES_ROOT = File.join(PLUGIN_ROOT, "templates")
+  ASSETS_ROOT = File.join(PLUGIN_ROOT, "assets")
+  DISTILL_REMOTE_LOADER_PATTERN = %r{https://distill\.pub/template\.v2\.js}
+
+  class PluginStaticFile < Jekyll::StaticFile; end
+
+  module_function
+
+  def enabled?(site)
+    site.config.dig("al_folio", "features", "distill", "enabled") != false
+  end
+
+  def remote_loader_allowed?(site)
+    site.config.dig("al_folio", "distill", "allow_remote_loader") == true
+  end
+
+  class AssetsGenerator < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      return unless AlFolioDistill.enabled?(site)
+
+      Dir.glob(File.join(ASSETS_ROOT, "**", "*")).sort.each do |source_path|
+        next if File.directory?(source_path)
+
+        relative_dir = File.dirname(source_path).sub("#{PLUGIN_ROOT}/", "")
+        site.static_files << PluginStaticFile.new(site, PLUGIN_ROOT, relative_dir, File.basename(source_path))
+      end
+    end
+  end
+
+  class RenderTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return "" unless site && AlFolioDistill.enabled?(site)
+
+      Liquid::Template.parse("{% include distill/render.liquid %}").render!(
+        context.environments.first,
+        registers: context.registers
+      )
+    end
+  end
+end
+
+Liquid::Template.register_tag("al_folio_distill_render", AlFolioDistill::RenderTag)
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  next unless site.respond_to?(:includes_load_paths)
+
+  include_path = AlFolioDistill::TEMPLATES_ROOT
+  site.includes_load_paths << include_path unless site.includes_load_paths.include?(include_path)
+end
+
+Jekyll::Hooks.register :site, :post_read do |site|
+  next unless AlFolioDistill.enabled?(site)
+  next if AlFolioDistill.remote_loader_allowed?(site)
+
+  transforms_path = File.join(AlFolioDistill::ASSETS_ROOT, "js", "distillpub", "transforms.v2.js")
+  next unless File.file?(transforms_path)
+
+  content = File.read(transforms_path)
+  if content.match?(AlFolioDistill::DISTILL_REMOTE_LOADER_PATTERN)
+    Jekyll.logger.warn("al_folio_distill:", "remote Distill template loader detected while `al_folio.distill.allow_remote_loader` is false")
+  end
+end

data/scripts/distill/sync_distill.sh

@@ -0,0 +1,72 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Sync vendored Distill runtime assets from a pinned upstream ref.
+#
+# Default upstream source:
+#   https://github.com/al-org-dev/distill-template.git (branch: al-folio)
+#
+# Usage:
+#   scripts/distill/sync_distill.sh [upstream-ref]
+#
+# Examples:
+#   scripts/distill/sync_distill.sh
+#   scripts/distill/sync_distill.sh <commit-sha>
+
+UPSTREAM_REPO="${UPSTREAM_REPO:-https://github.com/al-org-dev/distill-template.git}"
+UPSTREAM_BRANCH="${UPSTREAM_BRANCH:-al-folio}"
+DEFAULT_UPSTREAM_REF="d907ccdb526166c615f53487ec01e92e92f28f46"
+UPSTREAM_REF="${1:-${UPSTREAM_REF:-$DEFAULT_UPSTREAM_REF}}"
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
+TMP_DIR="$(mktemp -d)"
+
+cleanup() {
+  rm -rf "${TMP_DIR}"
+}
+trap cleanup EXIT
+
+git clone --quiet --depth 1 --branch "${UPSTREAM_BRANCH}" "${UPSTREAM_REPO}" "${TMP_DIR}/distill-template"
+pushd "${TMP_DIR}/distill-template" >/dev/null
+
+# Ensure deterministic vendoring from an explicit ref.
+git fetch --quiet --depth 1 origin "${UPSTREAM_REF}"
+git checkout --quiet "${UPSTREAM_REF}"
+
+OUT_DIR="${ROOT}/assets/js/distillpub"
+mkdir -p "${OUT_DIR}"
+cp dist/template.v2.js "${OUT_DIR}/template.v2.js"
+cp dist/template.v2.js.map "${OUT_DIR}/template.v2.js.map"
+cp dist/transforms.v2.js "${OUT_DIR}/transforms.v2.js"
+cp dist/transforms.v2.js.map "${OUT_DIR}/transforms.v2.js.map"
+cp dist/overrides.js "${OUT_DIR}/overrides.js"
+
+SOURCE_COMMIT="$(git rev-parse HEAD)"
+SOURCE_COMMIT_SHORT="$(git rev-parse --short HEAD)"
+popd >/dev/null
+
+TEMPLATE_SHA256="$(shasum -a 256 "${OUT_DIR}/template.v2.js" | awk '{print $1}')"
+TRANSFORMS_SHA256="$(shasum -a 256 "${OUT_DIR}/transforms.v2.js" | awk '{print $1}')"
+SYNCED_AT_UTC="$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
+
+cat > "${OUT_DIR}/provenance.json" <<JSON
+{
+  "upstream_repo": "${UPSTREAM_REPO}",
+  "upstream_branch": "${UPSTREAM_BRANCH}",
+  "upstream_ref": "${SOURCE_COMMIT}",
+  "upstream_ref_short": "${SOURCE_COMMIT_SHORT}",
+  "synced_at_utc": "${SYNCED_AT_UTC}",
+  "toolchain": {
+    "sync_mode": "copy-dist-artifacts"
+  },
+  "remote_loader_patched": false,
+  "assets": {
+    "template.v2.js": "${TEMPLATE_SHA256}",
+    "transforms.v2.js": "${TRANSFORMS_SHA256}",
+    "overrides.js": "$(shasum -a 256 "${OUT_DIR}/overrides.js" | awk '{print $1}')"
+  }
+}
+JSON
+
+echo "Synced Distill runtime from ${UPSTREAM_REPO}@${SOURCE_COMMIT}"
+echo "Updated assets in ${OUT_DIR}"

data/templates/distill/render.liquid

@@ -0,0 +1,131 @@
+<!doctype html>
+<html>
+  <head>
+    {% include head.liquid %}
+    <link rel="stylesheet" href="{{ '/assets/css/al-folio-distill.css' | relative_url | bust_file_cache }}">
+
+    <!-- Distill js -->
+    <script src="{{ '/assets/js/distillpub/template.v2.js' | relative_url }}"></script>
+    <script src="{{ '/assets/js/distillpub/transforms.v2.js' | relative_url }}"></script>
+    {% if page._styles %}
+      <!-- Page/Post style -->
+      <style type="text/css">
+        {{ page._styles }}
+      </style>
+    {% endif %}
+  </head>
+
+  <d-front-matter>
+    <script async type="text/json">
+      {
+            "title": "{{ page.title }}",
+            "description": "{{ page.description }}",
+            "published": "{{ page.date | date: '%B %d, %Y' }}",
+            "authors": [
+              {% for author in page.authors %}
+              {
+                "author": "{{ author.name }}",
+                "authorURL": "{{ author.url }}",
+                "affiliations": [
+                  {
+                    "name": "{{ author.affiliations.name }}",
+                    "url": "{{ author.affiliations.url }}"
+                  }
+                ]
+              }{% if forloop.last == false %},{% endif %}
+              {% endfor %}
+            ],
+            "katex": {
+              "delimiters": [
+                {
+                  "left": "$",
+                  "right": "$",
+                  "display": false
+                },
+                {
+                  "left": "$$",
+                  "right": "$$",
+                  "display": true
+                }
+              ]
+            }
+          }
+    </script>
+  </d-front-matter>
+
+  <body class="{% if site.navbar_fixed %}fixed-top-nav{% endif %} {% unless site.footer_fixed %}sticky-bottom-footer{% endunless %}">
+    <!-- Header -->
+    {% include header.liquid %}
+
+    <!-- Content -->
+    <div class="post distill">
+      <d-title>
+        <h1>{{ page.title }}</h1>
+        <p>{{ page.description }}</p>
+      </d-title>
+      {% if page.authors %}
+        <d-byline></d-byline>
+      {% endif %}
+
+      <d-article>
+        {% if page.toc and page.toc.size > 0 %}
+          <d-contents>
+            <nav class="l-text figcaption">
+              <h3>Contents</h3>
+              {% for section in page.toc %}
+                <div>
+                  <a href="#{{ section.name | slugify }}">{{ section.name }}</a>
+                </div>
+                {% if section.subsections %}
+                  <ul>
+                    {% for subsection in section.subsections %}
+                      <li>
+                        <a href="#{{ subsection.name | slugify }}">{{ subsection.name }}</a>
+                      </li>
+                    {% endfor %}
+                  </ul>
+                {% endif %}
+              {% endfor %}
+            </nav>
+          </d-contents>
+
+        {% elsif page.toc == true %}
+          <d-contents>
+            <nav class="l-text figcaption">
+              <h3>Contents</h3>
+              {% toc %}
+            </nav>
+          </d-contents>
+        {% endif %}
+
+        {{ content }}
+      </d-article>
+
+      <d-appendix>
+        <d-footnote-list></d-footnote-list>
+        <d-citation-list></d-citation-list>
+      </d-appendix>
+
+      <d-bibliography src="{{ page.bibliography | prepend: '/assets/bibliography/' | relative_url }}"></d-bibliography>
+
+      <d-article>
+        {% if site.related_blog_posts and site.related_blog_posts.enabled %}
+          {% if page.related_posts == null or page.related_posts %}
+            {% include related_posts.liquid %}
+          {% endif %}
+        {% endif %}
+        <br>
+        <br>
+        {% if site.plugins contains 'al_comments' %}
+          {% include plugins/al_comments.liquid %}
+        {% endif %}
+      </d-article>
+    </div>
+
+    <!-- Footer -->
+    {% include footer.liquid %}
+
+    <!-- JavaScripts -->
+    {% include distill/scripts.liquid %}
+  </body>
+</html>

data/templates/distill/scripts.liquid

@@ -0,0 +1,92 @@
+<script>
+  window.alFolio = {
+    compatBootstrap: {{ site.al_folio.compat.bootstrap.enabled | default: false | jsonify }}
+  };
+</script>
+
+<!-- Core navigation/runtime scripts -->
+<script src="{{ '/assets/js/nav-toggle.js' | relative_url | bust_file_cache }}"></script>
+{% if site.al_folio.compat.bootstrap.enabled %}
+  <script src="{{ '/assets/js/bootstrap-compat.js' | relative_url | bust_file_cache }}"></script>
+{% endif %}
+
+<!-- Custom overrides -->
+<script src="{{ '/assets/js/distillpub/overrides.js' | relative_url }}"></script>
+
+{% if site.plugins contains 'al_charts' %}
+  <!-- Charts and Diagrams -->
+  {% include plugins/al_charts_scripts.liquid %}
+{% endif %}
+
+{% if site.plugins contains 'al_math' %}
+  <!-- Math and Tikzjax -->
+  {% include plugins/al_math_scripts.liquid %}
+{% endif %}
+
+{% if page.typograms %}
+  <!-- Typograms -->
+  <script src="{{ '/assets/js/typograms.js' | relative_url | bust_file_cache }}"></script>
+{% endif %}
+
+<!-- Tooltips & popovers runtime -->
+<script src="{{ '/assets/js/tooltips-setup.js' | relative_url | bust_file_cache }}"></script>
+
+{% if page.pretty_table and site.al_folio.compat.bootstrap.enabled %}
+  <!-- Bootstrap Table -->
+  <!-- Bootstrap Table doesn't go well with diff2html -->
+  <script
+    defer
+    src="{{ site.third_party_libraries.bootstrap-table.url.js }}"
+    integrity="{{ site.third_party_libraries.bootstrap-table.integrity.js }}"
+    crossorigin="anonymous"
+  ></script>
+{% endif %}
+
+<!-- Load Common JS -->
+<script src="{{ '/assets/js/no_defer.js' | relative_url | bust_file_cache }}"></script>
+<script defer src="{{ '/assets/js/common.js' | relative_url | bust_file_cache }}"></script>
+<script defer src="{{ '/assets/js/copy_code.js' | relative_url | bust_file_cache }}" type="text/javascript"></script>
+
+<!-- Jupyter Open External Links New Tab -->
+<script defer src="{{ '/assets/js/jupyter_new_tab.js' | relative_url | bust_file_cache }}"></script>
+
+<!-- Removed Badges -->
+
+{% if site.enable_cookie_consent and site.plugins contains 'al_cookie' %}
+  <!-- Cookie Consent -->
+  {% include plugins/al_cookie_scripts.liquid %}
+{% endif %}
+{% if site.plugins contains 'al_analytics' %}
+  <!-- Analytics -->
+  {% include plugins/al_analytics_scripts.liquid %}
+{% endif %}
+
+{% if site.plugins contains 'al_img_tools' %}
+  <!-- Image Features -->
+  {% include plugins/al_img_tools_scripts.liquid %}
+{% endif %}
+
+{% if site.enable_progressbar %}
+  <!-- Scrolling Progress Bar -->
+  <script defer src="{{ '/assets/js/progress-bar.js' | relative_url | bust_file_cache }}" type="text/javascript"></script>
+{% endif %}
+
+{% if page.tabs %}
+  <!-- Jekyll Tabs -->
+  <script src="{{ '/assets/js/tabs.min.js' | relative_url | bust_file_cache }}"></script>
+{% endif %}
+
+{% if site.back_to_top %}
+  <!-- Back to Top -->
+  <script src="{{ '/assets/js/vanilla-back-to-top.min.js' | relative_url | bust_file_cache }}"></script>
+  <script>
+    addBackToTop();
+  </script>
+{% endif %}
+
+{% if site.search_enabled %}
+  <!-- Search -->
+  {% if site.plugins contains 'al_search' %}
+    {% include plugins/al_search_assets.liquid %}
+  {% endif %}
+{% endif %}

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: al_folio_distill
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- al-folio maintainers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides Distill templates, runtime assets, and policy checks for al-folio
+  sites.
+email:
+- maintainers@al-folio.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- assets/css/al-folio-distill.css
+- assets/js/distillpub/overrides.js
+- assets/js/distillpub/provenance.json
+- assets/js/distillpub/template.v2.js
+- assets/js/distillpub/template.v2.js.map
+- assets/js/distillpub/transforms.v2.js
+- assets/js/distillpub/transforms.v2.js.map
+- lib/al_folio_distill.rb
+- lib/al_folio_distill/version.rb
+- scripts/distill/sync_distill.sh
+- templates/distill/render.liquid
+- templates/distill/scripts.liquid
+homepage: https://github.com/al-org-dev/al-folio-distill
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/al-org-dev/al-folio-distill
+  source_code_uri: https://github.com/al-org-dev/al-folio-distill
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Distill rendering plugin for al-folio v1.x
+test_files: []