jekyll-vitepress-theme 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ca0f243e32e2dd051ee2c8bd0c073ec5ab1d2469d05e606531df740508a036f
-  data.tar.gz: caac258aed1a827394fdf8f6f239d81a6978b297567d5558c8433ead4504ded9
+  metadata.gz: 9e8e0506d69bd7172baf0392133cc0782815c07784a747437be2b7a59503ca37
+  data.tar.gz: 7037f54855dc45578def24ab7144a563f9211f7a441b110bfa56172cebdff91d
 SHA512:
-  metadata.gz: 04b1d2d66942c3c0e8277955be4936e268a8f7cbc0d3a818e6e7685ca7cc6b89f35944b252444ce708f6334a48e5d2a8cf62f55a3bcb707669c5fe33616db39d
-  data.tar.gz: 3d72ee616cf769d5c242de1bd5a0de440187206ecece4574fab664a5d98fc12efb0597b8dc1e2995c356602ba66676e351ffb3112b1fbe3c04f532ceec431bf6
+  metadata.gz: '08cad3bf3e61558a9ca8a9832f1ad95943289691c6832961405551f62d43399294a3f709f1e120a5a265a664c39ee46b3591a2e39dd20e3dc3ad92b3c603ea46'
+  data.tar.gz: 2cedeabbc9f8be7ded0ed39164d7808bc63178e84a7ef06aa2da6bddcfd6262047490eff29eb36da1dcd80393c0aba1bc33cc4340a5358af02bc4373c02f568e

data/README.md

@@ -78,6 +78,14 @@ bundle install
 bundle exec jekyll serve --livereload
 ```
 
+### Metadata and jekyll-seo-tag
+
+The theme writes the page description, canonical link, Open Graph, and Twitter
+card tags itself. Calling `{% seo %}` as well emits a second copy of each, so
+drop it when you switch to this theme, or drop the theme's tags if you prefer
+jekyll-seo-tag's. Its JSON-LD has no equivalent here, so keep that plugin if
+you want structured data.
+
 ## Screenshots
 
 | Home | Docs |

data/_includes/nav.html

@@ -103,8 +103,20 @@
               {% if versions and versions.items and versions.items.size > 0 %}
                 <div class="VPVersionSelector" id="vp-version-selector">
                   <button type="button" class="button" id="vp-version-button" aria-haspopup="true" aria-expanded="false" aria-controls="vp-version-menu">
+                    {%- comment -%}
+                      `current` names an item, by id or title, the way
+                      version_link.html matches it. Show that item's title so a
+                      manifest holding ids does not label the button "next".
+                    {%- endcomment -%}
+                    {%- assign version_current_label = versions.current -%}
+                    {%- for version_item in versions.items -%}
+                      {%- assign version_item_key = version_item.id | default: version_item.title -%}
+                      {%- if version_item_key == versions.current or version_item.title == versions.current -%}
+                        {%- assign version_current_label = version_item.title -%}
+                      {%- endif -%}
+                    {%- endfor -%}
                     <span class="text">
-                      <span>{{ versions.current | default: 'Version' }}</span>
+                      <span>{{ version_current_label | default: 'Version' }}</span>
                       <span class="vpi-chevron-down text-icon"></span>
                     </span>
                   </button>

data/assets/css/vitepress-overrides.css

@@ -329,6 +329,11 @@ body.vp-nav-screen-open .VPNav {
   width: 100%;
   height: 100%;
   fill: currentcolor;
+
+  /* These icons draw a 16-unit viewBox into a 13-14px box. Their paths touch
+     the viewBox edge, so at a fractional scale the SVG viewport clips the
+     outermost column and the shape looks flat on one side. */
+  overflow: visible;
 }
 
 .VPNavBarStarText,
@@ -1120,6 +1125,11 @@ body.vp-search-open {
   width: 100%;
   height: 100%;
   fill: currentcolor;
+
+  /* These icons draw a 16-unit viewBox into a 13-14px box. Their paths touch
+     the viewBox edge, so at a fractional scale the SVG viewport clips the
+     outermost column and the shape looks flat on one side. */
+  overflow: visible;
 }
 
 .VPMetricButtonCount {

data/lib/jekyll/vitepress_theme/hooks.rb

@@ -17,9 +17,26 @@ module Jekyll
         Jekyll.logger.warn('jekyll-vitepress-theme', "Sidebar hierarchy generation failed: #{e.message}")
       end
 
+      # A site with collection documents and no _data/sidebar.yml builds a page
+      # with an empty sidebar and no other complaint, which is a slow thing to
+      # notice. Overriding `data_dir` without carrying the file over is the
+      # usual cause.
+      def warn_missing_sidebar_data(site)
+        return if site.collections.values.all? { |collection| collection.docs.empty? }
+
+        Jekyll.logger.warn(
+          'jekyll-vitepress-theme',
+          'No _data/sidebar.yml found, so the sidebar will be empty. ' \
+          'If you set a custom data_dir, copy the theme data files into it.'
+        )
+      end
+
       def generate(site)
         sidebar_groups = site.data['sidebar']
-        return nil unless sidebar_groups.respond_to?(:each)
+        unless sidebar_groups.respond_to?(:each)
+          warn_missing_sidebar_data(site)
+          return nil
+        end
 
         groups = sidebar_groups.filter_map { |group| generated_group(site, group) }
 
@@ -384,7 +401,18 @@ module Jekyll
       module_function
 
       AUTO_VALUE = 'auto'.freeze
-
+      VERSION_PATTERN = /VERSION\s*=\s*['"]([^'"]+)['"]/
+
+      # Resolves `current: auto` to the version of the project being documented.
+      # Configure where to read it from:
+      #
+      #   jekyll_vitepress:
+      #     version:
+      #       value: "2.0.0"              # literal, wins over file
+      #       file: lib/my_gem/version.rb # or a file holding VERSION = '...'
+      #
+      # With neither, it falls back to this theme's own version, which is only
+      # ever right for the theme's own documentation.
       def apply(site)
         versions = site.data['versions']
         return unless versions.is_a?(Hash)
@@ -392,11 +420,35 @@ module Jekyll
         current_value = versions['current'] || versions[:current]
         return unless auto_value?(current_value)
 
-        versions['current'] = "v#{Jekyll::VitePressTheme::VERSION}"
+        versions['current'] = "v#{site_version(site) || Jekyll::VitePressTheme::VERSION}"
       rescue StandardError => e
         Jekyll.logger.warn('jekyll-vitepress-theme', "Version label resolution failed: #{e.message}")
       end
 
+      def site_version(site)
+        config = site.config.dig('jekyll_vitepress', 'version')
+        return nil unless config.is_a?(Hash)
+
+        literal = config['value'].to_s.strip
+        return normalize(literal) unless literal.empty?
+
+        version_from_file(site, config['file'])
+      end
+
+      def version_from_file(site, path)
+        return nil if path.to_s.strip.empty?
+
+        full_path = File.expand_path(path.to_s, site.source)
+        return nil unless File.file?(full_path)
+
+        match = File.read(full_path)[VERSION_PATTERN]
+        match && normalize(Regexp.last_match(1))
+      end
+
+      def normalize(value)
+        value.to_s.strip.sub(/\Av/, '')
+      end
+
       def auto_value?(value)
         value.to_s.strip.casecmp(AUTO_VALUE).zero?
       end

data/lib/jekyll/vitepress_theme/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module VitePressTheme
-    VERSION = "1.8.0".freeze
+    VERSION = "1.8.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-vitepress-theme
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Carmine Paolino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-22 00:00:00.000000000 Z
+date: 2026-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll