jekyll-vitepress-theme 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa9391084d58e782e53928675a222528a6e2bb36c206182f2e461d0bd87e7056
-  data.tar.gz: 535dd94bd744cbebe9767d9a6513a4ceb6164c391402f9108125ee0920554006
+  metadata.gz: c72127aab4edfc3683419977efbdde3e174b7d70970be4253fbccdcb6c32f8ea
+  data.tar.gz: 51bf7450c3ab178de305c5d81a1dccefa25fdfc6555a7d2fa2b7a6ecc5ef543a
 SHA512:
-  metadata.gz: ca5243e5c90205f0e37363c90bab9e02bc7e3235a2d7b873c843e00c40c5a78af014b6f80df88482935642c682cf639963febfb9df3a840ec2e53515b46a1802
-  data.tar.gz: 870b669c9cbe0096eb82fba8b878eba38de4c59f5e7a9fc00ee1f5a389304c33fdb34ab69047abc322f65eeaf9498a519e87a3d01b0f1a10e1bd7de8d2f29433
+  metadata.gz: cf130d94547b75b6ed9cb2b9e42518dbb8fd3294ab5b90f6c8f7901fc3b6b84a4655adb49b04f3051cf09fafb3a338f701d8a9bfddf445ead55b4cf894a3272f
+  data.tar.gz: f12ebaec4d69c77e9d6b2d5a6ddfd24f43fd6e86868d7f611d977fac62bce5d159db268f71e2032eeee2d66b85be8bb409635797e903b9cc3ceed1503cf3f486

data/README.md

@@ -7,10 +7,11 @@ 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`)
+- Optional GitHub star button with live count (`jekyll_vitepress.github_star`)
 - Code block copy button, language labels, file-title bars and icons
-- Rouge-native syntax theme config (`vp_theme.rouge_theme.light/dark`)
+- Rouge-native syntax theme config (`jekyll_vitepress.syntax.light_theme/dark_theme`)
 - Last-updated hook via plugin
-- Slot includes for lightweight theme extension (`_includes/vp_slots/head.html`, `doc_footer.html`, `layout_bottom.html`)
+- Jekyll-native extension hooks (`_includes/jekyll_vitepress/head_end.html`, `doc_footer_end.html`, `layout_end.html`)
 
 ## Installation
 
@@ -28,17 +29,30 @@ plugins:
   - jekyll-vitepress-theme
 ```
 
-3. Add `vp_theme` configuration:
+3. Add theme behavior config in `_config.yml`:
 
 ```yaml
-vp_theme:
-  nav:
-    - text: Guide
-      link: /what-is-jekyll-vitepress-theme/
-      collections: [getting_started, core_features, advanced]
-  sidebar_collections:
-    - id: getting_started
-      text: Introduction
+jekyll_vitepress:
+  branding:
+    site_title: My Docs
+  syntax:
+    light_theme: github
+    dark_theme: github.dark
+```
+
+4. Add navigation and sidebar data files:
+
+```yaml
+# _data/navigation.yml
+- title: Guide
+  url: /getting-started/
+  collections: [introduction, core_features, advanced]
+```
+
+```yaml
+# _data/sidebar.yml
+- title: Getting Started
+  collection: introduction
 ```
 
 ## Local development (this repo)
@@ -80,6 +94,7 @@ See docs pages:
 - [Getting Started](/getting-started/)
 - [Configuration Reference](/configuration-reference/)
 - [Frontmatter Reference](/frontmatter-reference/)
+- [VitePress Parity and Extensions](/vitepress-parity-and-extensions/)
 
 ## Release a gem
 

data/_includes/doc_footer.html

@@ -1,34 +1,45 @@
+{% assign theme = site.jekyll_vitepress %}
+{% assign page_theme = page.jekyll_vitepress %}
+
+{% assign edit_link_config = theme.edit_link %}
 {% assign edit_link_enabled = true %}
-{% if site.vp_theme.edit_link == false or page.edit_link == false %}
+{% if edit_link_config and edit_link_config.enabled == false %}
+  {% assign edit_link_enabled = false %}
+{% endif %}
+{% if page_theme.edit_link == false %}
   {% assign edit_link_enabled = false %}
 {% endif %}
 
 {% assign edit_link = nil %}
-{% if edit_link_enabled and site.vp_theme.edit_link and site.vp_theme.edit_link.pattern and page.path %}
-  {% assign edit_link = site.vp_theme.edit_link.pattern | replace: ':path', page.path %}
+{% if edit_link_enabled and edit_link_config and edit_link_config.pattern and page.path %}
+  {% assign edit_link = edit_link_config.pattern | replace: ':path', page.path %}
 {% endif %}
 
 {% assign edit_link_text = 'Edit this page on GitHub' %}
-{% if site.vp_theme.edit_link and site.vp_theme.edit_link.text %}
-  {% assign edit_link_text = site.vp_theme.edit_link.text %}
+{% if edit_link_config and edit_link_config.text %}
+  {% assign edit_link_text = edit_link_config.text %}
 {% endif %}
 
+{% assign last_updated_config = theme.last_updated %}
 {% assign last_updated_enabled = true %}
-{% if site.vp_theme.last_updated == false or page.last_updated == false %}
+{% if last_updated_config and last_updated_config.enabled == false %}
+  {% assign last_updated_enabled = false %}
+{% endif %}
+{% if page_theme.last_updated == false %}
   {% assign last_updated_enabled = false %}
 {% endif %}
 
 {% assign last_updated_text = 'Last updated' %}
-{% if site.vp_theme.last_updated and site.vp_theme.last_updated.text %}
-  {% assign last_updated_text = site.vp_theme.last_updated.text %}
+{% if last_updated_config and last_updated_config.text %}
+  {% assign last_updated_text = last_updated_config.text %}
 {% endif %}
 
 {% assign last_updated_format = '%-d %b %Y, %H:%M' %}
-{% if site.vp_theme.last_updated and site.vp_theme.last_updated.format %}
-  {% assign last_updated_format = site.vp_theme.last_updated.format %}
+{% if last_updated_config and last_updated_config.format %}
+  {% assign last_updated_format = last_updated_config.format %}
 {% endif %}
 
-{% assign last_updated_at = page.last_updated_at | default: page.last_updated | default: nil %}
+{% assign last_updated_at = page_theme.last_updated_at | default: nil %}
 {% assign show_last_updated = false %}
 {% if last_updated_enabled and last_updated_at %}
   {% assign show_last_updated = true %}
@@ -52,8 +63,12 @@
   {% endfor %}
 {% endif %}
 
+{% assign doc_footer_config = theme.doc_footer %}
 {% assign doc_footer_enabled = true %}
-{% if site.vp_theme.doc_footer == false or page.doc_footer == false %}
+{% if doc_footer_config and doc_footer_config.enabled == false %}
+  {% assign doc_footer_enabled = false %}
+{% endif %}
+{% if page_theme.doc_footer == false %}
   {% assign doc_footer_enabled = false %}
 {% endif %}
 
@@ -62,39 +77,39 @@
 {% assign prev_desc = 'Previous page' %}
 {% assign next_desc = 'Next page' %}
 
-{% if site.vp_theme.doc_footer and site.vp_theme.doc_footer != false %}
-  {% if site.vp_theme.doc_footer.prev == false %}
+{% if doc_footer_config %}
+  {% if doc_footer_config.previous_label == false %}
     {% assign prev_enabled = false %}
-  {% elsif site.vp_theme.doc_footer.prev %}
-    {% assign prev_desc = site.vp_theme.doc_footer.prev %}
+  {% elsif doc_footer_config.previous_label %}
+    {% assign prev_desc = doc_footer_config.previous_label %}
   {% endif %}
 
-  {% if site.vp_theme.doc_footer.next == false %}
+  {% if doc_footer_config.next_label == false %}
     {% assign next_enabled = false %}
-  {% elsif site.vp_theme.doc_footer.next %}
-    {% assign next_desc = site.vp_theme.doc_footer.next %}
+  {% elsif doc_footer_config.next_label %}
+    {% assign next_desc = doc_footer_config.next_label %}
   {% endif %}
 {% endif %}
 
-{% if page.doc_footer and page.doc_footer != false %}
-  {% if page.doc_footer.prev == false %}
+{% if page_theme.doc_footer and page_theme.doc_footer != false %}
+  {% if page_theme.doc_footer.prev == false %}
     {% assign prev_enabled = false %}
-  {% elsif page.doc_footer.prev %}
-    {% assign prev_desc = page.doc_footer.prev %}
+  {% elsif page_theme.doc_footer.prev %}
+    {% assign prev_desc = page_theme.doc_footer.prev %}
   {% endif %}
 
-  {% if page.doc_footer.next == false %}
+  {% if page_theme.doc_footer.next == false %}
     {% assign next_enabled = false %}
-  {% elsif page.doc_footer.next %}
-    {% assign next_desc = page.doc_footer.next %}
+  {% elsif page_theme.doc_footer.next %}
+    {% assign next_desc = page_theme.doc_footer.next %}
   {% endif %}
 {% endif %}
 
-{% if page.prev == false %}
+{% if page_theme.prev == false %}
   {% assign prev_enabled = false %}
 {% endif %}
 
-{% if page.next == false %}
+{% if page_theme.next == false %}
   {% assign next_enabled = false %}
 {% endif %}
 
@@ -104,9 +119,9 @@
 {% assign next_title = nil %}
 
 {% if prev_enabled %}
-  {% if page.prev and page.prev != false and page.prev.link %}
-    {% assign prev_url = page.prev.link %}
-    {% assign prev_title = page.prev.text | default: page.prev.link %}
+  {% if page_theme.prev and page_theme.prev != false and page_theme.prev.link %}
+    {% assign prev_url = page_theme.prev.link %}
+    {% assign prev_title = page_theme.prev.text | default: page_theme.prev.link %}
   {% elsif prev_doc %}
     {% assign prev_url = prev_doc.url | relative_url %}
     {% assign prev_title = prev_doc.title %}
@@ -114,9 +129,9 @@
 {% endif %}
 
 {% if next_enabled %}
-  {% if page.next and page.next != false and page.next.link %}
-    {% assign next_url = page.next.link %}
-    {% assign next_title = page.next.text | default: page.next.link %}
+  {% if page_theme.next and page_theme.next != false and page_theme.next.link %}
+    {% assign next_url = page_theme.next.link %}
+    {% assign next_title = page_theme.next.text | default: page_theme.next.link %}
   {% elsif next_doc %}
     {% assign next_url = next_doc.url | relative_url %}
     {% assign next_title = next_doc.title %}
@@ -132,8 +147,17 @@
   {% assign show_next_link = true %}
 {% endif %}
 
+{% capture doc_footer_end_markup %}
+  {% include jekyll_vitepress/doc_footer_end.html %}
+{% endcapture %}
+{% assign doc_footer_end_markup = doc_footer_end_markup | strip %}
+{% assign show_doc_footer_end = false %}
+{% if doc_footer_end_markup != '' %}
+  {% assign show_doc_footer_end = true %}
+{% endif %}
+
 {% assign show_footer = false %}
-{% if edit_link or show_last_updated or show_prev_link or show_next_link %}
+{% if edit_link or show_last_updated or show_prev_link or show_next_link or show_doc_footer_end %}
   {% assign show_footer = true %}
 {% endif %}
 
@@ -180,5 +204,9 @@
         </div>
       </nav>
     {% endif %}
+
+    {% if show_doc_footer_end %}
+      {{ doc_footer_end_markup }}
+    {% endif %}
   </footer>
 {% endif %}

data/_includes/head.html

@@ -4,12 +4,18 @@
   {% assign page_title = page.title | default: site.title %}
   <title>{% if page_title and page_title != site.title %}{{ page_title }} | {{ site.title }}{% else %}{{ site.title }}{% endif %}</title>
   <meta name="description" content="{{ page.description | default: site.description | escape }}">
-  <link rel="icon" href="{{ site.vp_theme.logo | default: site.vp_theme.logo_light | default: '/vitepress-logo-mini.svg' | relative_url }}">
-  {% assign vp_google_fonts_url = site.vp_theme.google_fonts_url | default: 'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap' %}
-  {% if vp_google_fonts_url %}
+
+  {% assign theme = site.jekyll_vitepress %}
+  {% assign branding = theme.branding %}
+  {% assign logo = branding.logo %}
+  <link rel="icon" href="{{ logo.default | default: logo.light | default: '/vitepress-logo-mini.svg' | relative_url }}">
+
+  {% assign typography = theme.typography %}
+  {% assign google_fonts_url = typography.google_fonts_url | default: 'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap' %}
+  {% if google_fonts_url and google_fonts_url != false and google_fonts_url != '' %}
     <link rel="preconnect" href="https://fonts.googleapis.com">
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-    <link rel="stylesheet" href="{{ vp_google_fonts_url }}">
+    <link rel="stylesheet" href="{{ google_fonts_url }}">
   {% endif %}
 
   <script>
@@ -41,27 +47,27 @@
   <link rel="stylesheet" href="{{ '/assets/css/vp-icons.css' | relative_url }}">
   <link rel="stylesheet" href="{{ '/assets/css/vitepress-overrides.css' | relative_url }}">
 
-  {% assign vp_font_family_base = site.vp_theme.font_family_base %}
-  {% assign vp_font_family_mono = site.vp_theme.font_family_mono %}
-  {% assign vp_css_vars_light = site.vp_theme.css_vars.light %}
-  {% assign vp_css_vars_dark = site.vp_theme.css_vars.dark %}
+  {% assign body_font_family = typography.body_font_family %}
+  {% assign code_font_family = typography.code_font_family %}
+  {% assign token_vars_light = theme.tokens.light %}
+  {% assign token_vars_dark = theme.tokens.dark %}
   {% assign has_theme_var_overrides = false %}
-  {% if vp_font_family_base or vp_font_family_mono %}
+  {% if body_font_family or code_font_family %}
     {% assign has_theme_var_overrides = true %}
   {% endif %}
-  {% if vp_css_vars_light and vp_css_vars_light.size > 0 %}
+  {% if token_vars_light and token_vars_light.size > 0 %}
     {% assign has_theme_var_overrides = true %}
   {% endif %}
-  {% if vp_css_vars_dark and vp_css_vars_dark.size > 0 %}
+  {% if token_vars_dark and token_vars_dark.size > 0 %}
     {% assign has_theme_var_overrides = true %}
   {% endif %}
   {% if has_theme_var_overrides %}
     <style id="vp-theme-vars">
       :root {
-        {% if vp_font_family_base %}--vp-font-family-base: {{ vp_font_family_base }};{% endif %}
-        {% if vp_font_family_mono %}--vp-font-family-mono: {{ vp_font_family_mono }};{% endif %}
-        {% if vp_css_vars_light %}
-          {% for pair in vp_css_vars_light %}
+        {% if body_font_family %}--vp-font-family-base: {{ body_font_family }};{% endif %}
+        {% if code_font_family %}--vp-font-family-mono: {{ code_font_family }};{% endif %}
+        {% if token_vars_light %}
+          {% for pair in token_vars_light %}
             {% assign css_var_name = pair[0] | strip %}
             {% if css_var_name contains '--' %}
               {{ css_var_name }}: {{ pair[1] }};
@@ -71,9 +77,9 @@
           {% endfor %}
         {% endif %}
       }
-      {% if vp_css_vars_dark and vp_css_vars_dark.size > 0 %}
+      {% if token_vars_dark and token_vars_dark.size > 0 %}
         .dark {
-          {% for pair in vp_css_vars_dark %}
+          {% for pair in token_vars_dark %}
             {% assign css_var_name = pair[0] | strip %}
             {% if css_var_name contains '--' %}
               {{ css_var_name }}: {{ pair[1] }};
@@ -86,13 +92,13 @@
     </style>
   {% endif %}
 
-  {% assign vp_rouge_css = site.vp_theme._generated_rouge_css %}
-  {% if vp_rouge_css and vp_rouge_css != '' %}
+  {% assign rouge_css = theme._generated_rouge_css %}
+  {% if rouge_css and rouge_css != '' %}
     <style id="vp-rouge-theme">
-{{ vp_rouge_css }}
+{{ rouge_css }}
     </style>
   {% endif %}
 
-  {% include vp_slots/head.html %}
+  {% include jekyll_vitepress/head_end.html %}
   <script src="{{ '/assets/js/vitepress-theme.js' | relative_url }}" defer></script>
 </head>

data/_includes/home.html

@@ -254,9 +254,9 @@
                   {% if feature.details %}
                     <p class="details">{{ feature.details }}</p>
                   {% endif %}
-                  {% if feature.linkText %}
+                  {% if feature.link_text %}
                     <div class="link-text">
-                      <p class="link-text-value">{{ feature.linkText }} <span class="vpi-arrow-right link-text-icon"></span></p>
+                      <p class="link-text-value">{{ feature.link_text }} <span class="vpi-arrow-right link-text-icon"></span></p>
                     </div>
                   {% endif %}
                 </article>
@@ -302,7 +302,7 @@
   {% endif %}
 
   {% if home_body != '' %}
-    {% if page.markdownStyles == false %}
+    {% if page.markdown_styles == false %}
       {{ include.content }}
     {% else %}
       <div class="VPHomeContent">

data/_includes/jekyll_vitepress/head_end.html

@@ -0,0 +1 @@
+<!-- Optional head hook. Override in your site at _includes/jekyll_vitepress/head_end.html. -->

data/_includes/local_nav.html

@@ -1,18 +1,19 @@
+{% assign labels = site.jekyll_vitepress.labels %}
 <div class="VPLocalNav has-sidebar" id="vp-local-nav">
   <div class="container">
     <button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" id="vp-local-menu-button">
       <span class="vpi-align-left menu-icon"></span>
-      <span class="menu-text">{{ site.vp_theme.sidebar_menu_label | default: 'Menu' }}</span>
+      <span class="menu-text">{{ labels.sidebar_menu | default: 'Menu' }}</span>
     </button>
 
     <div class="VPLocalNavOutlineDropdown" id="vp-local-outline-dropdown">
       <button type="button" id="vp-local-outline-button">
-        <span class="menu-text">{{ site.vp_theme.outline_title | default: 'On this page' }}</span>
+        <span class="menu-text">{{ labels.outline | default: 'On this page' }}</span>
         <span class="vpi-chevron-right icon"></span>
       </button>
       <div class="items" hidden>
         <div class="header">
-          <a class="top-link" href="#top" id="vp-local-top-link">{{ site.vp_theme.return_to_top_label | default: 'Return to top' }}</a>
+          <a class="top-link" href="#top" id="vp-local-top-link">{{ labels.return_to_top | default: 'Return to top' }}</a>
         </div>
         <div class="outline">
           <ul class="VPDocOutlineItem"></ul>