jekyll-vitepress-theme 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f21e5b46c57108b586ef2fd12ffeb0a63b67e2a8a9728814cd1b4a59a4c592
-  data.tar.gz: 36ab852e71ca5c212f3d4c9b0f14c5f9ad117447d79ee14fa036180f7585b6db
+  metadata.gz: 87a44689ffa884d7e6d6e6a7ab80c6919ecd5e09d828307d16a94816176fed28
+  data.tar.gz: 0b1346f4a809c05492379ac6464b958b251d4977e4a86fd7bfee6b758916856a
 SHA512:
-  metadata.gz: a0835b87b12521255a8c25114be2c9f05143f0317c0eb0387864c243b3e3215980f5d91cb24583036c4acaef2d7dbc777ecde37cc450273c4530fbdcf9cb3ac7
-  data.tar.gz: 7238521b04688036a2d79258cecfab250b8c99ff31abe3352b2b9a6ddedaf61e45b5accfa106f54c8c5845c31d7d8802853b54a0357b077f27a1f33792ea7ba1
+  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/assets/css/vitepress-overrides.css

@@ -1700,15 +1700,26 @@ html.dark .only-light {
 }
 
 /* Copy as Markdown button group */
-.vp-doc-header {
+.vp-doc-header,
+.vp-doc-title-row {
   display: flex;
   align-items: center;
   justify-content: space-between;
   gap: 12px;
+  flex-wrap: wrap;
 }
 
-.vp-doc-header h1 {
+.vp-doc-header h1,
+.vp-doc-title-row h1 {
   margin-top: 0;
+  margin-bottom: 0;
+  flex: 1 1 320px;
+  min-width: 0;
+}
+
+.vp-doc-header .copy-md-group,
+.vp-doc-title-row .copy-md-group {
+  margin-left: auto;
 }
 
 /* Copy page icon defs */

data/assets/js/vitepress-theme.js

@@ -1164,16 +1164,72 @@
   addCopyButtons();
 
   // Copy page as Markdown - split button with dropdown
+  function markdownStartsWithH1(markdown) {
+    var value = String(markdown || '').replace(/^\s+/, '');
+    return /^#\s+\S/.test(value) || /^<h1(?:\s|>)/i.test(value) || /^[^\n]+\n=+\s*(?:\n|$)/.test(value);
+  }
+
+  function resolveCopyPageTitleHeading() {
+    var doc = document.querySelector('.vp-doc');
+    if (!doc) {
+      return null;
+    }
+
+    var headerHeading = doc.querySelector('.vp-doc-header h1');
+    if (headerHeading) {
+      return headerHeading;
+    }
+
+    var headings = Array.from(doc.querySelectorAll('h1'));
+    for (var i = 0; i < headings.length; i += 1) {
+      if (!headings[i].closest('.vp-doc-header')) {
+        return headings[i];
+      }
+    }
+
+    return null;
+  }
+
+  function alignCopyPageButtonWithHeading() {
+    var header = document.querySelector('.vp-doc-header');
+    var group = header && header.querySelector('.copy-md-group');
+    if (!header || !group || header.querySelector('h1')) {
+      return;
+    }
+
+    var titleHeading = resolveCopyPageTitleHeading();
+    if (!titleHeading) {
+      return;
+    }
+
+    var titleRow = titleHeading.closest('.vp-doc-title-row');
+    if (!titleRow) {
+      titleRow = document.createElement('div');
+      titleRow.className = 'vp-doc-title-row';
+      titleHeading.parentNode.insertBefore(titleRow, titleHeading);
+      titleRow.appendChild(titleHeading);
+    }
+
+    titleRow.appendChild(group);
+
+    if (!header.querySelector('*')) {
+      header.hidden = true;
+    }
+  }
+
+  alignCopyPageButtonWithHeading();
+
   function copyPageMarkdown(btn) {
+    if (!btn) return;
+
     var textarea = document.querySelector('.vp-raw-markdown');
     if (!textarea) return;
 
     var md = textarea.value;
-    if (!/^#\s/.test(md.trim())) {
-      var header = document.querySelector('.vp-doc-header');
-      var autoH1 = header && header.querySelector('h1');
-      if (autoH1) {
-        var titleText = autoH1.textContent.trim();
+    if (!markdownStartsWithH1(md)) {
+      var titleHeading = resolveCopyPageTitleHeading();
+      if (titleHeading) {
+        var titleText = titleHeading.textContent.trim();
         if (titleText) {
           md = '# ' + titleText + '\n\n' + md;
         }

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
 
@@ -104,46 +173,81 @@ module Jekyll
         value.to_s.strip.casecmp(AUTO_VALUE).zero?
       end
     end
+
+    module CopyPage
+      module_function
+
+      def enabled?(item)
+        theme_config = item.site.config['jekyll_vitepress']
+        copy_page_disabled = theme_config.is_a?(Hash) &&
+                             theme_config['copy_page'].is_a?(Hash) &&
+                             theme_config['copy_page']['enabled'] == false
+
+        unless copy_page_disabled
+          page_theme = item.data['jekyll_vitepress']
+          copy_page_disabled = page_theme == false || (page_theme.is_a?(Hash) && page_theme['copy_page'] == false)
+        end
+
+        !copy_page_disabled
+      end
+
+      def resolved_markdown(item, payload)
+        raw = item.content.to_s
+        return raw unless item.respond_to?(:render_with_liquid?) && item.render_with_liquid?
+
+        item.renderer.render_liquid(raw, payload, liquid_render_info(item, payload), item.path)
+      rescue StandardError => e
+        relative_path = item.respond_to?(:relative_path) ? item.relative_path : item.path
+        Jekyll.logger.warn('jekyll-vitepress-theme', "Copy page markdown capture failed for #{relative_path}: #{e.message}")
+        raw
+      end
+
+      def liquid_render_info(item, payload)
+        liquid_options = item.site.config['liquid'] || {}
+
+        {
+          registers: { site: item.site, page: payload['page'] },
+          strict_filters: liquid_options['strict_filters'],
+          strict_variables: liquid_options['strict_variables']
+        }
+      end
+
+      def leading_h1?(markdown)
+        return false if markdown.nil?
+
+        stripped = markdown.lstrip
+        return false if stripped.empty?
+
+        stripped.match?(/\A#\s+\S/) ||
+          stripped.match?(/\A<h1(?:\s|>)/i) ||
+          stripped.match?(/\A[^\n]+\n=+\s*(?:\n|$)/)
+      end
+    end
   end
 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|
-  theme_config = document.site.config['jekyll_vitepress']
-  copy_page_disabled = theme_config.is_a?(Hash) &&
-                       theme_config['copy_page'].is_a?(Hash) &&
-                       theme_config['copy_page']['enabled'] == false
-
-  unless copy_page_disabled
-    page_theme = document.data['jekyll_vitepress']
-    copy_page_disabled = page_theme == false || (page_theme.is_a?(Hash) && page_theme['copy_page'] == false)
+Jekyll::Hooks.register :documents, :pre_render do |document, payload|
+  if Jekyll::VitePressTheme::CopyPage.enabled?(document)
+    document.data['_raw_markdown'] = Jekyll::VitePressTheme::CopyPage.resolved_markdown(document, payload)
   end
 
-  document.data['_raw_markdown'] = document.content unless copy_page_disabled
-
   next if document.data.key?('last_updated_at')
 
   updated_at = Jekyll::VitePressTheme::LastUpdated.source_file_time(document.site, document.path)
   document.data['last_updated_at'] = updated_at if updated_at
 end
 
-Jekyll::Hooks.register :pages, :pre_render do |page|
-  theme_config = page.site.config['jekyll_vitepress']
-  copy_page_disabled = theme_config.is_a?(Hash) &&
-                       theme_config['copy_page'].is_a?(Hash) &&
-                       theme_config['copy_page']['enabled'] == false
-
-  unless copy_page_disabled
-    page_theme = page.data['jekyll_vitepress']
-    copy_page_disabled = page_theme == false || (page_theme.is_a?(Hash) && page_theme['copy_page'] == false)
+Jekyll::Hooks.register :pages, :pre_render do |page, payload|
+  if Jekyll::VitePressTheme::CopyPage.enabled?(page)
+    page.data['_raw_markdown'] = Jekyll::VitePressTheme::CopyPage.resolved_markdown(page, payload)
   end
 
-  page.data['_raw_markdown'] = page.content unless copy_page_disabled
-
   next if page.data.key?('last_updated_at')
 
   updated_at = Jekyll::VitePressTheme::LastUpdated.source_file_time(page.site, page.path)
@@ -171,7 +275,7 @@ Jekyll::Hooks.register :site, :post_write do |site|
     md_path = '/index.md' if item.url == '/'
 
     title = item.data['title']
-    body = if title && !title.empty? && !raw.strip.start_with?('# ')
+    body = if title && !title.empty? && !Jekyll::VitePressTheme::CopyPage.leading_h1?(raw)
              "# #{title}\n\n#{raw}"
            else
              raw

data/lib/jekyll/vitepress_theme/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module VitePressTheme
-    VERSION = "1.2.0".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.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Carmine Paolino