al_comments 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8582e0b0a66b49c71cafbf872b834a2154e5221f8dc1520aac1b34b0e3fbbf8
+  data.tar.gz: 0fb8762fba4a9e91594be452e2584ff47726d9c41b5aeea8b91ccce4bf9f52a5
+SHA512:
+  metadata.gz: 8cd9477e85aecc152ac1ef75dd40d6663de2ff54835d41b435128893752f1d45586481a443ed07898adc66813207747b365ee0e73021b591a5067c916097ad0f
+  data.tar.gz: 9d66f7bfd9f311fa5dfe9811a65329b3817f4ab7d6c6184352bae96e5fe5c05db95b4b5c06e775e90fe92b5d4aa92fb3b682b241fa4a2f03374317daa84ca956

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 - 2026-02-07
+- Initial gem release.
+- Added standalone Giscus/Disqus comment rendering tag for Jekyll/al-folio sites.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Maruan Al-Shedivat.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Al-Comments
+
+A Jekyll plugin that provides reusable comment integrations for al-folio-compatible themes.
+
+## Features
+
+- Giscus comments
+- Disqus comments
+- Theme-aware Giscus setup
+
+## Installation
+
+Add this to your `Gemfile`:
+
+```ruby
+gem 'al_comments'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Enable in `_config.yml`:
+
+```yaml
+plugins:
+  - al_comments
+```
+
+Render comments where needed:
+
+```liquid
+{% al_comments %}
+```

data/lib/al_comments.rb

@@ -0,0 +1,127 @@
+require 'jekyll'
+require 'json'
+
+module AlComments
+  class CommentsTag < Liquid::Tag
+    def render(context)
+      site = context.registers[:site]
+      return '' unless site
+
+      page = context.registers[:page] || context['page'] || {}
+      output = []
+
+      if site.config['disqus_shortname'] && truthy?(page['disqus_comments'])
+        output << disqus_html(site, page)
+      end
+
+      if truthy?(page['giscus_comments'])
+        output << giscus_html(site, page)
+      end
+
+      output.join("\n")
+    end
+
+    private
+
+    def truthy?(value)
+      value == true || value.to_s == 'true'
+    end
+
+    def post_layout?(page)
+      page['layout'].to_s == 'post'
+    end
+
+    def disqus_html(site, page)
+      <<~HTML
+        <div id="disqus_thread" style="max-width: #{site.config['max_width']}; margin: 0 auto;">
+          <script type="text/javascript">
+            var disqus_shortname  = #{site.config['disqus_shortname'].to_json};
+            var disqus_identifier = #{page['id'].to_s.to_json};
+            var disqus_title      = #{page['title'].to_s.to_json};
+            (function() {
+              var dsq = document.createElement('script');
+              dsq.type = 'text/javascript';
+              dsq.async = true;
+              dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+              (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+            })();
+          </script>
+          <noscript>
+            Please enable JavaScript to view the
+            <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a>
+          </noscript>
+        </div>
+      HTML
+    end
+
+    def giscus_html(site, page)
+      giscus = site.config['giscus'] || {}
+      style = post_layout?(page) ? " style=\"max-width: #{site.config['max_width']}; margin: 0 auto;\"" : ''
+      spacer = post_layout?(page) ? "\n  <br>" : ''
+
+      if giscus['repo'].to_s.strip.empty?
+        warning = <<~MARKDOWN
+          > ##### giscus comments misconfigured
+          > Please follow instructions at [http://giscus.app](http://giscus.app) and update your giscus configuration.
+          {: .block-danger }
+        MARKDOWN
+        return %(<div id="giscus_thread"#{style}>#{spacer}\n#{Jekyll::Converters::Markdown.new(site.config).convert(warning)}</div>)
+      end
+
+      <<~HTML
+        <div id="giscus_thread"#{style}>#{spacer}
+          <script>
+            (function setupGiscus() {
+              function determineGiscusTheme() {
+                #{theme_detection(site)}
+              }
+
+              var giscusTheme = determineGiscusTheme();
+              var attrs = {
+                src: "https://giscus.app/client.js",
+                "data-repo": #{giscus['repo'].to_s.to_json},
+                "data-repo-id": #{giscus['repo_id'].to_s.to_json},
+                "data-category": #{giscus['category'].to_s.to_json},
+                "data-category-id": #{giscus['category_id'].to_s.to_json},
+                "data-mapping": #{giscus['mapping'].to_s.to_json},
+                "data-strict": #{giscus['strict'].to_s.to_json},
+                "data-reactions-enabled": #{giscus['reactions_enabled'].to_s.to_json},
+                "data-emit-metadata": #{giscus['emit_metadata'].to_s.to_json},
+                "data-input-position": #{giscus['input_position'].to_s.to_json},
+                "data-theme": giscusTheme,
+                "data-lang": #{giscus['lang'].to_s.to_json},
+                crossorigin: "anonymous",
+                async: true
+              };
+
+              var giscusScript = document.createElement("script");
+              Object.entries(attrs).forEach(function(entry) { giscusScript.setAttribute(entry[0], entry[1]); });
+              var host = document.getElementById("giscus_thread");
+              if (host) host.appendChild(giscusScript);
+            })();
+          </script>
+          <noscript>
+            Please enable JavaScript to view the
+            <a href="http://giscus.app/?ref_noscript">comments powered by giscus.</a>
+          </noscript>
+        </div>
+      HTML
+    end
+
+    def theme_detection(site)
+      if site.config['enable_darkmode']
+        <<~JS
+          var theme = localStorage.getItem("theme") || document.documentElement.getAttribute("data-theme") || "system";
+          if (theme === "dark") return #{site.config.dig('giscus', 'dark_theme').to_s.to_json};
+          if (theme === "light") return #{site.config.dig('giscus', 'light_theme').to_s.to_json};
+          var prefersDark = window.matchMedia("(prefers-color-scheme: dark)").matches;
+          return prefersDark ? #{site.config.dig('giscus', 'dark_theme').to_s.to_json} : #{site.config.dig('giscus', 'light_theme').to_s.to_json};
+        JS
+      else
+        %(return #{site.config.dig('giscus', 'light_theme').to_s.to_json};)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('al_comments', AlComments::CommentsTag)

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: al_comments
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- al-org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-02-07 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'
+description: Jekyll plugin extracted from al-folio that renders theme-aware Giscus
+  and Disqus comment blocks via a reusable Liquid tag.
+email:
+- dev@al-org.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/al_comments.rb
+homepage: https://github.com/al-org-dev/al-comments
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/al-org-dev/al-comments
+  source_code_uri: https://github.com/al-org-dev/al-comments
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Giscus and Disqus comments tag for Jekyll sites
+test_files: []