jekyll-vitepress-theme 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647316f68a7edd8f657e980003c6b064bab2c69b0e1f279047cd6bd9199c5102
-  data.tar.gz: 3a9e1bed45e86b11d8df502f9f1f2916191965ed377ceedaa7df0f1cec15725e
+  metadata.gz: f175074cdc25f3c9545388ece6e5140ac1b31e514641a6c1ab66612b996ba5fc
+  data.tar.gz: 98d3593dae2959af719fe81d7b01cba9d7a8ca739cb6bd573d9a710d653b96be
 SHA512:
-  metadata.gz: 6539cb54e120f1cfc45506c1f94e844ae35d21048908a46aa9865a05ad35adb12d24db70a5750ebddb41f6278c39bd8c35ae15a39a718685c4905058e2014d48
-  data.tar.gz: e4e66dcbb3631ae7cdf5f6751e6ba47e6da64ec3e97f9350c1ef53e6b08e84a13ba78bf9d579376a2142cc1217d93ea94ba831e7c4ed66df1b65a01cb302283c
+  metadata.gz: 44d14ac6e9e6785003b8e9d99e53961f6a6b8c0d4559f5e77f5ee4ff159ff69cc412a03377ce70d6087db59b795ee86f01fcd3816c0b00aea3c1c76040f4d6b5
+  data.tar.gz: 1ea58cd6c5e5f2326bf166bbebd6fb6aed35c851ede6a8715116f32a5c24409f176df8794efff35d3070ab484553d7317e371c9f6b237fc7ff0359a299cdf9ec

data/README.md

@@ -23,7 +23,7 @@ The unusual part is navigation. Internal docs links use Turbo Frames, so page ch
 
 ## Why Use It
 
-- **VitePress-like UX:** top nav, persistent sidebar, right outline, doc footer pager, search modal, and theme toggle.
+- **VitePress-like UX:** top nav, persistent sidebar, right outline, doc footer pager, search modal, theme toggle, and optional GitHub Star/Sponsor buttons.
 - **Turbo page navigation:** only the docs content frame swaps, so the shell stays in place and page changes feel fast.
 - **Jekyll-native setup:** configure everything with `_config.yml`, `_data/*.yml`, collections, includes, and frontmatter.
 - **Ruby syntax pipeline:** Rouge powers light and dark syntax themes without a separate JavaScript build.

data/_includes/nav.html

@@ -29,6 +29,29 @@
 {% if github_star_enabled %}
   {% assign github_star_url = 'https://github.com/' | append: github_star_repository %}
 {% endif %}
+{% assign github_sponsor_config = theme.github_sponsor %}
+{% assign github_sponsor_enabled = false %}
+{% assign github_sponsor_url = nil %}
+{% assign github_sponsor_text = 'Sponsor' %}
+{% assign github_sponsor_label = 'Sponsor on GitHub' %}
+{% if github_sponsor_config and github_sponsor_config != false %}
+  {% assign github_sponsor_user = github_sponsor_config.user | default: github_sponsor_config.username | default: github_sponsor_config.account %}
+  {% assign github_sponsor_url = github_sponsor_config.url %}
+  {% if github_sponsor_url == nil or github_sponsor_url == '' %}
+    {% if github_sponsor_user %}
+      {% assign github_sponsor_url = 'https://github.com/sponsors/' | append: github_sponsor_user %}
+    {% endif %}
+  {% endif %}
+  {% if github_sponsor_config.text %}
+    {% assign github_sponsor_text = github_sponsor_config.text %}
+  {% endif %}
+  {% if github_sponsor_config.label %}
+    {% assign github_sponsor_label = github_sponsor_config.label %}
+  {% endif %}
+  {% if github_sponsor_config.enabled != false and github_sponsor_url %}
+    {% assign github_sponsor_enabled = true %}
+  {% endif %}
+{% endif %}
 
 <header class="VPNav">
   <div class="VPNavBar{% if include.has_sidebar %} has-sidebar{% endif %}{% if include.is_home %} home{% endif %} top" id="vp-nav-bar">
@@ -151,6 +174,18 @@
                             </a>
                           </div>
                         {% endif %}
+                        {% if github_sponsor_enabled %}
+                          <div class="VPNavBarStar VPNavBarSponsor">
+                            <a class="VPLink link no-icon VPNavBarStarLink VPNavBarSponsorLink" href="{{ github_sponsor_url }}" aria-label="{{ github_sponsor_label | escape }}" target="_blank" rel="noreferrer noopener">
+                              <span class="VPNavBarSponsorIcon" aria-hidden="true">
+                                <svg viewBox="0 0 16 16" focusable="false">
+                                  <path d="M8 13.25l-.7-.64C3.1 8.79 1 6.88 1 4.5 1 2.56 2.56 1 4.5 1c1.1 0 2.15.51 2.83 1.31A3.76 3.76 0 0 1 10.5 1C12.44 1 14 2.56 14 4.5c0 2.38-2.1 4.29-6.3 8.11l-.7.64z"></path>
+                                </svg>
+                              </span>
+                              <span class="VPNavBarStarText">{{ github_sponsor_text }}</span>
+                            </a>
+                          </div>
+                        {% endif %}
 
                         {% for social in social_links %}
                           {% assign social_icon_name = social.icon %}
@@ -196,6 +231,18 @@
                   </a>
                 </div>
               {% endif %}
+              {% if github_sponsor_enabled %}
+                <div class="VPNavBarStar VPNavBarSponsor" id="vp-nav-sponsor">
+                  <a class="VPLink link no-icon VPNavBarStarLink VPNavBarSponsorLink" href="{{ github_sponsor_url }}" aria-label="{{ github_sponsor_label | escape }}" target="_blank" rel="noreferrer noopener">
+                    <span class="VPNavBarSponsorIcon" aria-hidden="true">
+                      <svg viewBox="0 0 16 16" focusable="false">
+                        <path d="M8 13.25l-.7-.64C3.1 8.79 1 6.88 1 4.5 1 2.56 2.56 1 4.5 1c1.1 0 2.15.51 2.83 1.31A3.76 3.76 0 0 1 10.5 1C12.44 1 14 2.56 14 4.5c0 2.38-2.1 4.29-6.3 8.11l-.7.64z"></path>
+                      </svg>
+                    </span>
+                    <span class="VPNavBarStarText">{{ github_sponsor_text }}</span>
+                  </a>
+                </div>
+              {% endif %}
               {% for social in social_links %}
                 {% assign social_icon_name = social.icon %}
                 {% assign social_icon_svg = social.icon_svg %}
@@ -304,6 +351,18 @@
             </a>
           </div>
         {% endif %}
+        {% if github_sponsor_enabled %}
+          <div class="VPNavBarStar VPNavScreenStar VPNavBarSponsor">
+            <a class="VPLink link no-icon VPNavBarStarLink VPNavScreenStarLink VPNavBarSponsorLink" href="{{ github_sponsor_url }}" aria-label="{{ github_sponsor_label | escape }}" target="_blank" rel="noreferrer noopener">
+              <span class="VPNavBarSponsorIcon" aria-hidden="true">
+                <svg viewBox="0 0 16 16" focusable="false">
+                  <path d="M8 13.25l-.7-.64C3.1 8.79 1 6.88 1 4.5 1 2.56 2.56 1 4.5 1c1.1 0 2.15.51 2.83 1.31A3.76 3.76 0 0 1 10.5 1C12.44 1 14 2.56 14 4.5c0 2.38-2.1 4.29-6.3 8.11l-.7.64z"></path>
+                </svg>
+              </span>
+              <span class="VPNavBarStarText">{{ github_sponsor_text }}</span>
+            </a>
+          </div>
+        {% endif %}
         {% for social in social_links %}
           {% assign social_icon_name = social.icon %}
           {% assign social_icon_svg = social.icon_svg %}

data/assets/css/vitepress-overrides.css

@@ -302,6 +302,20 @@ body.vp-nav-screen-open .VPNav {
   color: currentcolor;
 }
 
+.VPNavBarSponsorIcon {
+  display: inline-flex;
+  width: 20px;
+  height: 20px;
+  color: currentcolor;
+}
+
+.VPNavBarSponsorIcon svg {
+  display: block;
+  width: 100%;
+  height: 100%;
+  fill: currentcolor;
+}
+
 .VPNavBarStarText,
 .VPNavBarStarCount {
   display: none;
@@ -338,6 +352,11 @@ body.vp-nav-screen-open .VPNav {
     height: 14px;
   }
 
+  .VPNavBarSponsorIcon {
+    width: 14px;
+    height: 14px;
+  }
+
   .VPNavBarStarText {
     display: inline;
   }
@@ -498,6 +517,11 @@ body.vp-nav-screen-open .VPNav {
   height: 14px;
 }
 
+.VPNavScreenSocialLinks .VPNavBarSponsorIcon {
+  width: 14px;
+  height: 14px;
+}
+
 .VPNavScreenSocialLinks .VPNavBarStarText,
 .VPNavScreenSocialLinks .VPNavBarStarCount {
   display: inline;

data/assets/js/vitepress-theme.js

@@ -1945,6 +1945,23 @@
   syncPersistentNavState();
 
   if (window.Turbo) {
+    document.addEventListener('turbo:frame-missing', function (event) {
+      if (!event.target || event.target.id !== 'vp-content-frame') {
+        return;
+      }
+
+      event.preventDefault();
+
+      if (event.detail && typeof event.detail.visit === 'function' && event.detail.response) {
+        event.detail.visit(event.detail.response);
+        return;
+      }
+
+      if (event.detail && event.detail.response && event.detail.response.url) {
+        window.location.href = event.detail.response.url;
+      }
+    });
+
     document.addEventListener('turbo:frame-load', function (event) {
       if (!event.target || event.target.id !== 'vp-content-frame') {
         return;

data/lib/jekyll/vitepress_theme/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module VitePressTheme
-    VERSION = "1.3.0".freeze
+    VERSION = "1.4.0".freeze
   end
 end

metadata

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