jekyll-refergen 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975de0a6fd9db5c2daef29a57671df169bab0502a3073d70deb01279e89721d0
-  data.tar.gz: 745ae6b1033ea2eecd73c2cefd388038fb9270b3c2db6878f62c775f6d10de36
+  metadata.gz: e590b644a9abe0f2de11955ae50d0da67ac54dbcd1cdd3478ef7196dc6bbbead
+  data.tar.gz: 8927925a82183080a7e5c90d82aa0b3c21519fdc40acfbd78ce1f28592aa1faf
 SHA512:
-  metadata.gz: b02d8376e10b863a151d5e5d1421dca541eb4cb30887f6b832b5eb3b7b003c56d7c27a681242fd2a6e11390ce304c8c1c1074af68ff75d537fe77b5bef458355
-  data.tar.gz: 9d6cb4baf1cb0310596edbb9e55f9bb64202a96185a466069638eeac3e0a4a9be03a6989e8a5e6af3a1c43e61bd3730ef6bdd1d2152a9331a4c6f5b0c2c2835b
+  metadata.gz: 70c27dc044e30365a61638e579089ed9be3ca66c9f2f9c84f0c7e348661a90f0c295c196fb1de22c1952a8b00c8618fd42ed53acdf34dbbead525c6e7e7c02ed
+  data.tar.gz: a2e822df48d961b41cc44643a5fb7c1b7d628a749215d6239ed72e54482de034e126d2ccf33366ad057fd20ad0b5c1926d08b80e316ffe044108ad2f73caf9e0

data/README.md

@@ -1,4 +1,4 @@
-# jeklly-refergen
+# jekyll-refergen
 Don’t forget to include a reference at the end of your posts.
 
 ---
@@ -8,35 +8,76 @@ Don’t forget to include a reference at the end of your posts.
 1. **Gem Installation**
    - Add to your Gemfile:
      ```ruby
-     gem 'jeklly-refergen', git: 'https://github.com/yourname/jeklly-refergen.git'
+     gem 'jekyll-refergen', git: 'https://github.com/yourname/jekyll-refergen.git'
      ```
    - Or after publishing to rubygems.org:
      ```ruby
-     gem 'jeklly-refergen'
+     gem 'jekyll-refergen'
      ```
    - Run `bundle install`
 
 2. **_config.yml Configuration**
    ```yaml
-   reference_plugin:
+   refergen-plugin:
      collections: ["posts", "wiki"] # Specify which collections to process
    ```
-   - The plugin will process all documents in the specified collections.
+   - The plugin processes all documents in the listed collections.
 
-3. **Usage Example**
-   - In your post/page content:
+3. **Usage Examples**
+   - Deduplicate by URL (same URL → same reference number):
      ```markdown
      [Example1](https://www.example.com), [Example2](https://www.example2.com), [Again Example1](https://www.example.com)
      ```
-   - Will be rendered as:
+     Renders 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>
+     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-3">[1]</a></sup>
 
      ---
      ## Reference
-     1. <a id="ref-1"></a>[Example1](https://www.example.com)<br/>
+     1. <a id="ref-1"></a>[Example1](https://www.example.com) ^ <a href="#ref-link-1">a</a> <a href="#ref-link-3">b</a><br/>
      2. <a id="ref-2"></a>[Example2](https://www.example2.com)<br/>
      ```
+     When the same URL is referenced multiple times, the Reference section shows `^a b c` format where each letter links to the corresponding reference location in the text.
+   
+   - Custom reference label: use the Markdown link title (`"..."` or unquoted) as the reference display name.
+     ```markdown
+     [Visible text](https://www.example.com "Custom label")
+     [Another link](https://www.example.com Custom label)
+     ```
+     Renders as:
+     ```markdown
+     Visible text<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>
+     Another link<sup><a href="#ref-1" id="ref-link-2">[1]</a></sup>
+
+     ---
+     ## Reference
+     1. <a id="ref-1"></a>[Custom label](https://www.example.com) ^ <a href="#ref-link-1">a</a> <a href="#ref-link-2">b</a><br/>
+     ```
+
+4. **Local Test (example)**
+   - Install dependencies:
+     ```bash
+     bundle install
+     ```
+   - Prepare a test Jekyll site (create one if needed):
+     ```bash
+     bundle exec jekyll new demo-site --skip-bundle
+     cd demo-site
+     bundle add ../jekyll-refergen # reference local plugin
+     ```
+   - Add plugin to `_config.yml`:
+     ```yaml
+     plugins:
+       - jekyll-refergen
+     refergen-plugin:
+       collections: ["posts"]
+     ```
+   - Add the usage examples to a post, then build/serve:
+     ```bash
+     bundle exec jekyll build
+     bundle exec jekyll serve
+     ```
+   - In the rendered HTML, verify same URLs share the same number and the title is used as the reference label when provided.
 
 ---
 
@@ -73,7 +114,7 @@ jobs:
 ```
 
 - 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.
+- If your Gemfile includes `jekyll-refergen`, the plugin will work in the GitHub Actions environment.
 
 ---
 

data/lib/jekyll/refergen/reference_generator.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module Jekyll
   module Refergen
     class ReferenceGenerator < Jekyll::Generator
@@ -21,31 +20,96 @@ module Jekyll
       private
 
       def process_references(content)
-        # Extract [text](url) patterns
-        references = content.scan(/\[([^\]]+)\]\(([^\)]+)\)/)
+        link_data = extract_link_data(content)
+        return content if link_data.empty?
+
+        replaced_content = replace_links(content, link_data)
+        reference_section = generate_reference_section(link_data)
+        replaced_content + reference_section
+      end
+
+      def extract_link_data(content)
         url_to_number = {}
-        number = 1
-        references.each do |name, url|
-          url_to_number[url] ||= number
-          number += 1 if url_to_number[url] == number
+        url_to_label = {}
+        url_to_link_positions = {}
+        link_index = 0
+
+        content.scan(/\[([^\]]+)\]\(([^\)]+)\)/) do |text, url_part|
+          link_index += 1
+          url, ref_name = parse_link(url_part)
+
+          # Assign reference number
+          num = url_to_number[url] ||= url_to_number.length + 1
+
+          # Store label (use first occurrence)
+          label = ref_name&.strip
+          label = text if label.nil? || label.empty?
+          url_to_label[url] ||= label
+
+          # Track link positions for this URL
+          url_to_link_positions[url] ||= []
+          url_to_link_positions[url] << link_index
+        end
+
+        {
+          url_to_number: url_to_number,
+          url_to_label: url_to_label,
+          url_to_link_positions: url_to_link_positions
+        }
+      end
+
+      def parse_link(url_part)
+        # Try to match quoted title: url "title"
+        if url_part.match(/^([^\s\)]+)\s+"([^"]+)"$/)
+          [Regexp.last_match(1), Regexp.last_match(2)]
+        # Try to match unquoted title: url title
+        elsif url_part.match(/^([^\s\)]+)\s+(.+)$/)
+          [Regexp.last_match(1), Regexp.last_match(2)]
+        # No title: just url
+        else
+          [url_part, nil]
         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)
+      end
+
+      def replace_links(content, link_data)
+        url_to_number = link_data[:url_to_number]
+        url_to_label = link_data[:url_to_label]
+        link_counter = 0
+
+        content.gsub(/\[([^\]]+)\]\(([^\)]+)\)/) do
+          link_counter += 1
+          text = Regexp.last_match(1)
+          url_part = Regexp.last_match(2)
+          url, = parse_link(url_part)
+
           num = url_to_number[url]
-          "#{name}<sup><a href=\"#ref-#{num}\" id=\"ref-link-#{num}\">[#{num}]</a></sup>"
+          "#{text}<sup><a href=\"#ref-#{num}\" id=\"ref-link-#{link_counter}\">[#{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
+
+      def generate_reference_section(link_data)
+        url_to_number = link_data[:url_to_number]
+        url_to_label = link_data[:url_to_label]
+        url_to_link_positions = link_data[:url_to_link_positions]
+
+        reference_section = "\n\n---\n## Reference\n"
+
+        url_to_number.sort_by { |_, num| num }.each do |url, num|
+          label = url_to_label[url]
+          positions = url_to_link_positions[url]
+
+          # Generate position links (^a b c format)
+          position_links = positions.map.with_index do |pos, idx|
+            letter = ('a'.ord + idx).chr
+            "<a href=\"#ref-link-#{pos}\">#{letter}</a>"
+          end.join(' ')
+
+          position_prefix = positions.length > 1 ? " ^ #{position_links}" : ""
+
+          reference_section += "#{num}. <a id=\"ref-#{num}\"></a>[#{label}](#{url})#{position_prefix}<br/>\n"
         end
-        replaced_content
+
+        reference_section
       end
     end
   end

data/lib/jekyll/refergen/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Refergen
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-refergen
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Minseong Lee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-10 00:00:00.000000000 Z
+date: 2025-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll