jekyll-refergen 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93bd72fabdb08bd4ae0643d5e654be1634c9d08f4a577bac24174b2b244c6ab1
+  data.tar.gz: f03cb2cb39101cd05daf744371cff913788cd264246fbb5a7549b83de5681e79
+SHA512:
+  metadata.gz: af2178d64f8d5f57851bc9a6f2a2ce5f5981b1a745b19fc0f0742113f0d41ae9f40e2a1b78428a804a4292c21b41c22b0990087746d0caa4c5670be0d67caa1e
+  data.tar.gz: ea5ed017ad28d9371585e49ee3f59afdb9438936c03aa00cf254f4c143126d69d4fa6c980c83c2d6396ca45b95d40f4c401242ec924da0fc50016a368246ad35

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Min-Seong Lee
+
+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,82 @@
+# jeklly-refergen
+Don’t forget to include a reference at the end of your posts.
+
+---
+
+## Gem Installation and Usage
+
+1. **Gem Installation**
+   - Add to your Gemfile:
+     ```ruby
+     gem 'jeklly-refergen', git: 'https://github.com/yourname/jeklly-refergen.git'
+     ```
+   - Or after publishing to rubygems.org:
+     ```ruby
+     gem 'jeklly-refergen'
+     ```
+   - Run `bundle install`
+
+2. **_config.yml Configuration**
+   ```yaml
+   reference_plugin:
+     collections: ["posts", "wiki"] # Specify which collections to process
+   ```
+   - The plugin will process all documents in the specified collections.
+
+3. **Usage Example**
+   - In your post/page content:
+     ```markdown
+     [Example1](https://www.example.com), [Example2](https://www.example2.com), [Again Example1](https://www.example.com)
+     ```
+   - Will be rendered as:
+     ```markdown
+     Example1<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>, Example2<sup><a href="#ref-2" id="ref-link-2">[2]</a></sup>, Again Example1<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>
+
+     ---
+     ## Reference
+     1. <a id="ref-1"></a>[Example1](https://www.example.com)<br/>
+     2. <a id="ref-2"></a>[Example2](https://www.example2.com)<br/>
+     ```
+
+---
+
+## Github Actions: Automatic Deployment
+
+1. Create `.github/workflows/deploy.yml`
+2. Add the following workflow:
+
+```yaml
+name: Build & Deploy Jekyll
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+      - name: Install dependencies
+        run: bundle install
+      - name: Build site
+        run: bundle exec jekyll build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_site
+```
+
+- This workflow builds your Jekyll site and deploys the `_site` folder to GitHub Pages on every push to the master branch.
+- If your Gemfile includes `jeklly-refergen`, the plugin will work in the GitHub Actions environment.
+
+---
+
+### Notes
+- The plugin works with Jekyll 3.x and 4.x.
+- Custom gem plugins are not supported on the official GitHub Pages build server. You must use GitHub Actions or another external build server for deployment.

data/lib/jekyll/jekyll-refergen.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "jekyll/refergen/version"
+require "jekyll/refergen/reference_generator" 

data/lib/jekyll/refergen/reference_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+puts "aaaaaaa"
+
+module Jekyll
+  module Refergen
+    class ReferenceGenerator < Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        puts "aaaaaaa"
+        config = site.config["refergen-plugin"] || {}
+        collections = config["collections"] || ["posts"]
+
+        puts collections
+        collections.each do |col|
+          next unless site.collections[col]
+          site.collections[col].docs.each do |doc|
+            doc.content = process_references(doc.content)
+          end
+        end
+      end
+
+      private
+
+      def process_references(content)
+        # Extract [text](url) patterns
+        references = content.scan(/\[([^\]]+)\]\(([^\)]+)\)/)
+        url_to_number = {}
+        number = 1
+        references.each do |name, url|
+          url_to_number[url] ||= number
+          number += 1 if url_to_number[url] == number
+        end
+        # Replace [name](url) with name<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>
+        replaced_content = content.gsub(/\[([^\]]+)\]\(([^\)]+)\)/) do
+          name = Regexp.last_match(1)
+          url = Regexp.last_match(2)
+          num = url_to_number[url]
+          "#{name}<sup><a href=\"#ref-#{num}\" id=\"ref-link-#{num}\">[#{num}]</a></sup>"
+        end
+        # Generate Reference section
+        if url_to_number.any?
+          reference_section = "\n\n---\n## Reference\n"
+          url_to_number.sort_by { |_, num| num }.each do |url, num|
+            name = references.find { |n, u| u == url }&.first || url
+            reference_section += "#{num}. <a id=\"ref-#{num}\"></a>[#{name}](#{url})<br/>\n"
+          end
+          replaced_content += reference_section
+        end
+        replaced_content
+      end
+    end
+  end
+end 

data/lib/jekyll/refergen/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Refergen
+    VERSION = "0.1.2"
+  end
+end 

data/lib/jekyll-refergen.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "jekyll/jekyll-refergen"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-refergen
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Minseong Lee
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Jekyll plugin that automatically converts in-text references ([name](url))
+  to Wikipedia-style superscripted numbered references and generates a Reference section
+  at the end of the document. Only documents updated after a configurable date are
+  processed.
+email:
+- dlaepeul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-refergen.rb
+- lib/jekyll/jekyll-refergen.rb
+- lib/jekyll/refergen/reference_generator.rb
+- lib/jekyll/refergen/version.rb
+homepage: https://github.com/minseon9/jekyll-refergen
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Jekyll Reference Generator Plugin
+test_files: []