jekyll-vitepress-theme 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66fe5075d52518e812e3a2d8f6e17af3ac03678587c4ba791e577189b725374f
-  data.tar.gz: 692859f3b2f76e628a59235a565cd4837663e663896d0d0770ac2ab123b2dc62
+  metadata.gz: 87a44689ffa884d7e6d6e6a7ab80c6919ecd5e09d828307d16a94816176fed28
+  data.tar.gz: 0b1346f4a809c05492379ac6464b958b251d4977e4a86fd7bfee6b758916856a
 SHA512:
-  metadata.gz: 99c56f6757de3f76dd02188eb5f044b65d431b094153b75ea69c88cfc5af427a3467a3a96cf4e07c5434899b5942a8f00ad7b0886b0db39f816f3fff6ac3548f
-  data.tar.gz: a6abce7ca7eaf12ec365ad41eb800f7f9ca7d470851670eda401979f7c45f8e499766d7c2fb9aff72702f52fbda95cbb017b4c4f8711f11d7dd19db9de7f44e1
+  metadata.gz: 137bbe877456978ccfd6d4565a3c05f6efa686f6361b8970ea21eb0aa93d659db5f286e460dd2d398ccab8b39e09f0c33c1b77e50a01a966ee161f459db467f9
+  data.tar.gz: 9ce78c0cc99df03cb514841771d83b8de04a058418dcb7694c69b631dcb2e1a3b1b38f3b4bf86e159f2babc1ab50ae9700f59fe031910f3713fcf193e8e390a0

data/README.md

@@ -7,6 +7,7 @@ A reusable Jekyll theme gem that reproduces the VitePress default docs experienc
 - VitePress-style layout structure (top nav, sidebar, outline, doc footer)
 - Appearance toggle with `auto -> dark -> light`
 - Local search modal (`/`, `Ctrl/Cmd+K`, `Cmd+K`)
+- Automatic `/search.json` generation for the home page and sidebar collections
 - Optional GitHub star button with live count (`jekyll_vitepress.github_star`)
 - Code block copy button, language labels, file-title bars and icons
 - Page-level "Copy page" split button with raw Markdown copy + plain `.md` view (`jekyll_vitepress.copy_page`, enabled by default)

data/lib/jekyll/vitepress_theme/hooks.rb

@@ -3,6 +3,75 @@ require 'rouge'
 
 module Jekyll
   module VitePressTheme
+    module SearchIndex
+      module_function
+
+      TEMPLATE = <<~LIQUID.freeze
+        [
+        {% assign first = true %}
+        {% assign home_page = site.pages | where: 'url', '/' | first %}
+        {% if home_page %}
+          {% assign home_excerpt = home_page.content | markdownify | strip_html | strip_newlines | replace: '  ', ' ' | strip | truncate: 2400, '' %}
+          {
+            "title": {{ home_page.title | default: site.title | strip_html | strip | jsonify }},
+            "url": {{ home_page.url | relative_url | jsonify }},
+            "content": {{ home_excerpt | jsonify }}
+          }
+          {% assign first = false %}
+        {% endif %}
+        {% assign sidebar_groups = site.data.sidebar %}
+        {% for group in sidebar_groups %}
+          {% assign docs = site[group.collection] | sort: 'nav_order' %}
+          {% for doc in docs %}
+            {% if doc.title and doc.url %}
+              {% unless first %},{% endunless %}
+              {% assign excerpt = doc.content | markdownify | strip_html | strip_newlines | replace: '  ', ' ' | strip | truncate: 2400, '' %}
+              {
+                "title": {{ doc.title | strip_html | strip | jsonify }},
+                "url": {{ doc.url | relative_url | jsonify }},
+                "content": {{ excerpt | jsonify }}
+              }
+              {% assign first = false %}
+            {% endif %}
+          {% endfor %}
+        {% endfor %}
+        ]
+      LIQUID
+
+      class GeneratedPage < Jekyll::PageWithoutAFile
+        def initialize(site)
+          super(site, site.source, '', 'search.json')
+
+          self.content = TEMPLATE
+          data['layout'] = nil
+          data['permalink'] = '/search.json'
+        end
+      end
+
+      def apply(site)
+        return if custom_page?(site)
+
+        site.pages << GeneratedPage.new(site)
+      end
+
+      def custom_page?(site)
+        site.pages.any? { |page| search_index_path?(page.path) || search_index_url?(page.url) } ||
+          site.static_files.any? { |file| search_index_path?(file.path) || search_index_url?(file.relative_path) }
+      end
+
+      def search_index_path?(value)
+        return false unless value
+
+        Pathname.new(value.to_s).basename.to_s == 'search.json'
+      rescue ArgumentError
+        false
+      end
+
+      def search_index_url?(value)
+        value.to_s.strip == '/search.json'
+      end
+    end
+
     module LastUpdated
       module_function
 
@@ -160,6 +229,7 @@ end
 Jekyll::Hooks.register :site, :post_read do |site|
   Jekyll::VitePressTheme::VersionLabel.apply(site)
   Jekyll::VitePressTheme::RougeStyles.apply(site)
+  Jekyll::VitePressTheme::SearchIndex.apply(site)
 end
 
 Jekyll::Hooks.register :documents, :pre_render do |document, payload|

data/lib/jekyll/vitepress_theme/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module VitePressTheme
-    VERSION = "1.2.1".freeze
+    VERSION = "1.2.2".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-vitepress-theme
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Carmine Paolino