jekyll-vitepress-theme 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b441f74c3173193c1236784b889d74d8c3d63920b8df58c7a810de72e35d2953
-  data.tar.gz: a4ff1d25d78309553f30ea9bf660accbbdad9c4ec5001cd2e25fac63541f7911
+  metadata.gz: d9f21e5b46c57108b586ef2fd12ffeb0a63b67e2a8a9728814cd1b4a59a4c592
+  data.tar.gz: 36ab852e71ca5c212f3d4c9b0f14c5f9ad117447d79ee14fa036180f7585b6db
 SHA512:
-  metadata.gz: b10e1e1833cac956149bb63b925027950196d9a9bd806a3a51548128083b98d5935a0f4f7da79f86117905e026c12e4b198cd4969fbc3cddd31726c91ef343c2
-  data.tar.gz: ac38b254d36662b388cd457872d3d689f6fda67cd6ecbcb499ce00b728d1a576ee31343145d6ad87603ac038aeb633f6978257b5b39eb664c7b6e943d0772945
+  metadata.gz: a0835b87b12521255a8c25114be2c9f05143f0317c0eb0387864c243b3e3215980f5d91cb24583036c4acaef2d7dbc777ecde37cc450273c4530fbdcf9cb3ac7
+  data.tar.gz: 7238521b04688036a2d79258cecfab250b8c99ff31abe3352b2b9a6ddedaf61e45b5accfa106f54c8c5845c31d7d8802853b54a0357b077f27a1f33792ea7ba1

data/README.md

@@ -9,10 +9,29 @@ A reusable Jekyll theme gem that reproduces the VitePress default docs experienc
 - 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
+- Page-level "Copy page" split button with raw Markdown copy + plain `.md` view (`jekyll_vitepress.copy_page`, enabled by default)
 - Rouge-native syntax theme config (`jekyll_vitepress.syntax.light_theme/dark_theme`)
 - Last-updated hook via plugin
 - Jekyll-native extension hooks (`_includes/jekyll_vitepress/head_end.html`, `doc_footer_end.html`, `layout_end.html`)
 
+## Screenshots
+
+### Home (Light)
+
+![Home light mode](assets/images/screenshots/home-light.png)
+
+### Home (Dark)
+
+![Home dark mode](assets/images/screenshots/home-dark.png)
+
+### Getting Started (Light)
+
+![Getting Started light mode](assets/images/screenshots/getting-started-light.png)
+
+### Getting Started (Dark)
+
+![Getting Started dark mode](assets/images/screenshots/getting-started-dark.png)
+
 ## Installation
 
 1. Add the gem to your `Gemfile`:

data/_includes/copy_page_button.html

@@ -0,0 +1,29 @@
+{% assign view_md_url = page.url | replace: '.html', '' | append: '.md' | replace: '/.md', '.md' %}
+{% if page.url == '/' %}
+  {% assign view_md_url = '/index.md' %}
+{% endif %}
+<div class="copy-md-group">
+  <button class="copy-md-btn" type="button" title="Copy page as Markdown">
+    <span class="vpi-copy"></span>
+    <span class="copy-md-label">Copy page</span>
+  </button>
+  <button class="copy-md-toggle" type="button" aria-label="More options" aria-expanded="false">
+    <span class="vpi-chevron-down copy-md-chevron"></span>
+  </button>
+  <div class="copy-md-dropdown" hidden>
+    <button class="copy-md-dropdown-item" type="button" data-action="copy">
+      <span class="vpi-copy copy-md-dropdown-icon"></span>
+      <div class="copy-md-dropdown-text">
+        <span class="copy-md-dropdown-title">Copy page</span>
+        <span class="copy-md-dropdown-desc">Copy page as Markdown for LLMs</span>
+      </div>
+    </button>
+    <a class="copy-md-dropdown-item" href="{{ view_md_url | relative_url }}" target="_blank" rel="noreferrer">
+      <span class="vpi-file-text copy-md-dropdown-icon"></span>
+      <div class="copy-md-dropdown-text">
+        <span class="copy-md-dropdown-title">View as Markdown</span>
+        <span class="copy-md-dropdown-desc">View this page as plain text</span>
+      </div>
+    </a>
+  </div>
+</div>

data/_layouts/default.html

@@ -61,8 +61,23 @@
                             {% assign show_auto_page_title = true %}
                           {% endunless %}
                         {% endif %}
-                        {% if show_auto_page_title %}
-                          <h1>{{ page.title }}</h1>
+                        {% assign copy_page_enabled = true %}
+                        {% if theme.copy_page and theme.copy_page.enabled == false %}
+                          {% assign copy_page_enabled = false %}
+                        {% endif %}
+                        {% if page_theme.copy_page == false %}
+                          {% assign copy_page_enabled = false %}
+                        {% endif %}
+                        <div class="vp-doc-header">
+                          {% if show_auto_page_title %}
+                            <h1>{{ page.title }}</h1>
+                          {% endif %}
+                          {% if copy_page_enabled and page._raw_markdown and page._raw_markdown != "" %}
+                            {% include copy_page_button.html %}
+                          {% endif %}
+                        </div>
+                        {% if copy_page_enabled and page._raw_markdown and page._raw_markdown != "" %}
+                          <textarea class="vp-raw-markdown" style="display:none" aria-hidden="true">{{ page._raw_markdown | xml_escape }}</textarea>
                         {% endif %}
                         {{ content }}
                       </div>
@@ -87,8 +102,23 @@
                             {% assign show_auto_page_title = true %}
                           {% endunless %}
                         {% endif %}
-                        {% if show_auto_page_title %}
-                          <h1>{{ page.title }}</h1>
+                        {% assign copy_page_enabled = true %}
+                        {% if theme.copy_page and theme.copy_page.enabled == false %}
+                          {% assign copy_page_enabled = false %}
+                        {% endif %}
+                        {% if page_theme.copy_page == false %}
+                          {% assign copy_page_enabled = false %}
+                        {% endif %}
+                        <div class="vp-doc-header">
+                          {% if show_auto_page_title %}
+                            <h1>{{ page.title }}</h1>
+                          {% endif %}
+                          {% if copy_page_enabled and page._raw_markdown and page._raw_markdown != "" %}
+                            {% include copy_page_button.html %}
+                          {% endif %}
+                        </div>
+                        {% if copy_page_enabled and page._raw_markdown and page._raw_markdown != "" %}
+                          <textarea class="vp-raw-markdown" style="display:none" aria-hidden="true">{{ page._raw_markdown | xml_escape }}</textarea>
                         {% endif %}
                         {{ content }}
                       </div>

data/assets/css/vitepress-overrides.css

@@ -1698,3 +1698,168 @@ html.dark .only-light {
     margin-left: 0;
   }
 }
+
+/* Copy as Markdown button group */
+.vp-doc-header {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 12px;
+}
+
+.vp-doc-header h1 {
+  margin-top: 0;
+}
+
+/* Copy page icon defs */
+.vpi-copy {
+  --icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cg fill='none' stroke='black' stroke-linecap='round' stroke-linejoin='round' stroke-width='2'%3E%3Crect x='9' y='9' width='13' height='13' rx='2' ry='2'/%3E%3Cpath d='M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1'/%3E%3C/g%3E%3C/svg%3E");
+}
+
+.vpi-file-text {
+  --icon: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cg fill='none' stroke='black' stroke-linecap='round' stroke-linejoin='round' stroke-width='2'%3E%3Cpath d='M14 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V8z'/%3E%3Cpolyline points='14 2 14 8 20 8'/%3E%3Cline x1='16' y1='13' x2='8' y2='13'/%3E%3Cline x1='16' y1='17' x2='8' y2='17'/%3E%3Cpolyline points='10 9 9 9 8 9'/%3E%3C/g%3E%3C/svg%3E");
+}
+
+/* Copy page split button */
+.copy-md-group {
+  position: relative;
+  display: inline-flex;
+  align-items: stretch;
+  flex-shrink: 0;
+  border: 1px solid var(--vp-c-divider);
+  border-radius: 6px;
+  background: var(--vp-c-bg-soft);
+  transition: color 0.25s, border-color 0.25s, background-color 0.25s;
+}
+
+.copy-md-group:hover {
+  border-color: var(--vp-c-brand-1);
+}
+
+.copy-md-btn {
+  display: inline-flex;
+  align-items: center;
+  gap: 6px;
+  padding: 4px 10px;
+  border: none;
+  border-radius: 6px 0 0 6px;
+  background: transparent;
+  color: var(--vp-c-text-2);
+  font-size: 12px;
+  font-weight: 600;
+  cursor: pointer;
+  transition: color 0.25s, background-color 0.25s;
+  white-space: nowrap;
+}
+
+.copy-md-btn .vpi-copy {
+  width: 14px;
+  height: 14px;
+}
+
+.copy-md-btn:hover {
+  color: var(--vp-c-text-1);
+  background: var(--vp-c-bg-elv);
+}
+
+.copy-md-btn.copied {
+  color: var(--vp-c-green-1, #42b883);
+}
+
+.copy-md-toggle {
+  display: inline-flex;
+  align-items: center;
+  padding: 4px 6px;
+  border: none;
+  border-left: 1px solid var(--vp-c-divider);
+  border-radius: 0 6px 6px 0;
+  background: transparent;
+  color: var(--vp-c-text-2);
+  cursor: pointer;
+  transition: color 0.25s, background-color 0.25s;
+}
+
+.copy-md-toggle .vpi-chevron-down {
+  width: 14px;
+  height: 14px;
+}
+
+.copy-md-toggle:hover {
+  color: var(--vp-c-text-1);
+  background: var(--vp-c-bg-elv);
+}
+
+.copy-md-toggle[aria-expanded="true"] .copy-md-chevron {
+  transform: rotate(180deg);
+}
+
+.copy-md-chevron {
+  transition: transform 0.2s;
+}
+
+/* Dropdown */
+.copy-md-dropdown {
+  position: absolute;
+  top: calc(100% + 6px);
+  right: 0;
+  z-index: 10;
+  min-width: 240px;
+  padding: 6px;
+  border: 1px solid var(--vp-c-divider);
+  border-radius: 8px;
+  background: var(--vp-c-bg);
+  box-shadow: var(--vp-shadow-1);
+}
+
+.copy-md-dropdown-item {
+  display: flex;
+  align-items: flex-start;
+  gap: 10px;
+  width: 100%;
+  padding: 8px 10px;
+  border: none;
+  border-radius: 6px;
+  background: transparent;
+  color: var(--vp-c-text-1);
+  text-decoration: none;
+  text-align: left;
+  cursor: pointer;
+  transition: background-color 0.15s;
+}
+
+.copy-md-dropdown-item:hover {
+  background: var(--vp-c-bg-soft);
+}
+
+a.copy-md-dropdown-item,
+a.copy-md-dropdown-item:hover {
+  text-decoration: none;
+  color: var(--vp-c-text-1);
+}
+
+.copy-md-dropdown-icon {
+  flex-shrink: 0;
+  width: 18px;
+  height: 18px;
+  margin-top: 2px;
+  color: var(--vp-c-text-2);
+}
+
+.copy-md-dropdown-text {
+  display: flex;
+  flex-direction: column;
+  gap: 2px;
+}
+
+.copy-md-dropdown-title {
+  font-size: 13px;
+  font-weight: 500;
+  line-height: 1.3;
+  display: inline;
+}
+
+.copy-md-dropdown-desc {
+  font-size: 12px;
+  color: var(--vp-c-text-3);
+  line-height: 1.3;
+}

data/assets/js/vitepress-theme.js

@@ -1163,6 +1163,83 @@
 
   addCopyButtons();
 
+  // Copy page as Markdown - split button with dropdown
+  function copyPageMarkdown(btn) {
+    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 (titleText) {
+          md = '# ' + titleText + '\n\n' + md;
+        }
+      }
+    }
+
+    var label = btn.querySelector('.copy-md-label');
+    writeToClipboard(md)
+      .then(function () {
+        btn.classList.add('copied');
+        if (label) label.textContent = 'Copied';
+        if (btn._copyTimeout) window.clearTimeout(btn._copyTimeout);
+        btn._copyTimeout = window.setTimeout(function () {
+          btn.classList.remove('copied');
+          if (label) label.textContent = 'Copy page';
+        }, 2000);
+      })
+      .catch(function () {});
+  }
+
+  var copyMdBtn = document.querySelector('.copy-md-btn');
+  if (copyMdBtn) {
+    copyMdBtn.addEventListener('click', function () {
+      copyPageMarkdown(copyMdBtn);
+    });
+  }
+
+  // Dropdown toggle
+  var toggle = document.querySelector('.copy-md-toggle');
+  var dropdown = document.querySelector('.copy-md-dropdown');
+  if (toggle && dropdown) {
+    toggle.addEventListener('click', function (e) {
+      e.stopPropagation();
+      var open = !dropdown.hidden;
+      dropdown.hidden = !dropdown.hidden;
+      toggle.setAttribute('aria-expanded', !open);
+    });
+
+    // Copy from dropdown item
+    var dropdownCopy = dropdown.querySelector('[data-action="copy"]');
+    if (dropdownCopy) {
+      dropdownCopy.addEventListener('click', function () {
+        dropdown.hidden = true;
+        toggle.setAttribute('aria-expanded', 'false');
+        copyPageMarkdown(copyMdBtn);
+      });
+    }
+
+    // Close on outside click
+    document.addEventListener('click', function (e) {
+      if (!dropdown.hidden && !dropdown.contains(e.target) && !toggle.contains(e.target)) {
+        dropdown.hidden = true;
+        toggle.setAttribute('aria-expanded', 'false');
+      }
+    });
+
+    // Close on Escape
+    document.addEventListener('keydown', function (e) {
+      if (e.key === 'Escape' && !dropdown.hidden) {
+        dropdown.hidden = true;
+        toggle.setAttribute('aria-expanded', 'false');
+        toggle.focus();
+      }
+    });
+  }
+
   var content = document.querySelector('.vp-doc');
   if (!content) {
     return;

data/lib/jekyll/vitepress_theme/hooks.rb

@@ -113,6 +113,18 @@ Jekyll::Hooks.register :site, :post_read do |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)
+  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)
@@ -120,8 +132,53 @@ Jekyll::Hooks.register :documents, :pre_render do |document|
 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)
+  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)
   page.data['last_updated_at'] = updated_at if updated_at
 end
+
+# Write raw .md files after site build using the same content as "Copy page"
+Jekyll::Hooks.register :site, :post_write do |site|
+  theme_config = site.config['jekyll_vitepress']
+  if theme_config.is_a?(Hash) &&
+     theme_config['copy_page'].is_a?(Hash) &&
+     theme_config['copy_page']['enabled'] == false
+    next
+  end
+
+  items = site.pages.select { |p| p.output_ext == '.html' } +
+          site.collections.values.flat_map(&:docs)
+
+  items.each do |item|
+    raw = item.data['_raw_markdown']
+    next if raw.nil? || raw.empty?
+
+    base_path = item.url.sub(/\.html$/, '').sub(%r{/$}, '')
+    md_path = "#{base_path}.md"
+    md_path = '/index.md' if item.url == '/'
+
+    title = item.data['title']
+    body = if title && !title.empty? && !raw.strip.start_with?('# ')
+             "# #{title}\n\n#{raw}"
+           else
+             raw
+           end
+
+    dest = File.join(site.dest, md_path)
+    FileUtils.mkdir_p(File.dirname(dest))
+    File.write(dest, body)
+  end
+end

data/lib/jekyll/vitepress_theme/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module VitePressTheme
-    VERSION = "1.1.1".freeze
+    VERSION = "1.2.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-vitepress-theme
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Carmine Paolino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-19 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -41,6 +41,7 @@ files:
 - LICENSE
 - README.md
 - _includes/alert.html
+- _includes/copy_page_button.html
 - _includes/doc_footer.html
 - _includes/head.html
 - _includes/home.html
@@ -89,6 +90,10 @@ files:
 - assets/images/file-icons/yaml-dark.svg
 - assets/images/file-icons/yaml.svg
 - assets/images/logo.svg
+- assets/images/screenshots/getting-started-dark.png
+- assets/images/screenshots/getting-started-light.png
+- assets/images/screenshots/home-dark.png
+- assets/images/screenshots/home-light.png
 - assets/images/social-icons/bitbucket.svg
 - assets/images/social-icons/bluesky.svg
 - assets/images/social-icons/devdotto.svg