fix: llms plugin headers & remove slot

Author: onmax

docs/vitepress-theme/index.md

@@ -147,12 +147,12 @@ export default defineConfig(() => {
           repoURL: 'https://github.com/your-org/your-repo' // Can be different from main repoURL
         },
 
-        // Markdown generation (optional)
-        // Set to false to disable automatic markdown generation
-        // Or customize with options
-        markdown: {
-          cacheTTL: 3600000, // Cache duration in milliseconds (default: 1 hour)
-          verbose: false // Enable verbose logging (default: false)
+        // LLM-friendly markdown generation (optional)
+        // Set to false to disable .md outputs
+        // Or customize using vitepress-plugin-llms settings
+        llms: {
+          domain: 'https://docs.nimiq.com',
+          injectLLMHint: false
         }
       })
     ]
@@ -169,14 +169,14 @@ export default defineConfig(() => {
 | `repoURL`      | `string`            | -              | GitHub repository URL used for source code links and as default for GitChangelog |
 | `contentPath`  | `string`            | `''`           | Directory path where documentation files are located relative to repository root |
 | `gitChangelog` | `object \| false`   | Uses `repoURL` | Git changelog configuration or `false` to disable                                |
-| `markdown`     | `object \| boolean` | `true`         | Markdown generation options or `false` to disable                                |
+| `llms`         | `object \| boolean` | `true`         | LLM-friendly markdown generation options or `false` to disable                   |
 
 The plugin automatically:
 
 - Configures Git changelog functionality using the provided repository URL
 - Enables source code viewing and copying features
 - Constructs proper URLs for "View Source" and "Edit Page" links
-- Generates markdown files for all HTML pages during build
+- Generates LLM-optimized markdown files for every page using `vitepress-plugin-llms`
 
 ### Register the theme as internal dependency
 
@@ -206,14 +206,14 @@ For more information about why configure this, please refer to the [Server-Side
 
 ## Copy Page as Markdown
 
-The theme automatically generates markdown versions of all HTML pages during build using the [@mdream/vite](https://github.com/harlan-zw/mdream) plugin. This enables users to easily copy page content as markdown for use with LLMs, note-taking apps, or other tools.
+The theme automatically generates markdown versions of all HTML pages during build using the [vitepress-plugin-llms](https://github.com/okineadev/vitepress-plugin-llms) toolkit. This enables users to easily copy page content as markdown for use with LLMs, note-taking apps, or other tools.
 
 ### How it works
 
-1. **Automatic Generation**: The `NimiqVitepressVitePlugin` includes the mdream Vite plugin which automatically converts HTML pages to markdown during build
-2. **Development Support**: In dev mode, markdown is generated on-demand when accessing any page with `.md` extension (e.g., `/guide.html` → `/guide.md`)
+1. **Automatic Generation**: The `NimiqVitepressVitePlugin` bundles `vitepress-plugin-llms`, which converts each documentation page into a dedicated `.md` file during build
+2. **Development Support**: In dev mode, the plugin serves `.md` pages through the Vite dev server so you can copy or test locally without a full build
 3. **Copy Button**: Each page includes a "Copy page" button that fetches the generated markdown and copies it to the clipboard
-4. **Configurable**: You can customize caching, verbose logging, or disable the feature entirely through the plugin options
+4. **Configurable**: You can override any `llmstxt` settings (e.g., domain, hints, additional outputs) or disable the integration entirely through the plugin options
 
 The markdown files are saved alongside their corresponding HTML files in the build output (e.g., `getting-started.html` → `getting-started.md`).
 
@@ -224,12 +224,13 @@ You can configure the markdown generation or disable it entirely:
 ```ts
 NimiqVitepressVitePlugin({
   // Disable markdown generation
-  markdown: false,
+  llms: false,
 
   // Or customize options
-  markdown: {
-    cacheTTL: 7200000, // 2 hours cache
-    verbose: true // Enable logging
+  llms: {
+    domain: 'https://docs.example.com',
+    generateLLMsTxt: true, // Enable llms.txt sitemap
+    generateLLMsFullTxt: false, // Keep the bundle light
   }
 })
 ```
@@ -325,34 +326,6 @@ copyOptions: source-only  # Show only "View Source" button
 ---
 ```
 
-## Custom Header Slot
-
-Add custom content between the search bar and modules dropdown in the header navigation.
-
-```ts [.vitepress/theme/index.ts]
-import { defineNimiqThemeConfig } from 'nimiq-vitepress-theme/theme'
-import CustomHeaderNav from './CustomHeaderNav.vue'
-
-export default defineNimiqThemeConfig({
-  Layout() {
-    return {
-      'header-nav-before-modules': CustomHeaderNav
-    }
-  }
-})
-```
-
-```vue [.vitepress/theme/CustomHeaderNav.vue]
-<template>
-  <a href="https://example.com" target="_blank" flex="~ items-center gap-8" f-px-2xs py-4 f-rounded-xs bg="transparent hocus:neutral-200" transition-colors>
-    <div i-tabler:external-link />
-    <span f-text-sm font-medium>Docs</span>
-  </a>
-</template>
-```
-
-The slot appears in both desktop header and mobile sidebar (above the modules selector) in the home layout.
-
 ## Customization
 
 This theme **has not been developed with customatization in mind**. In fact, it has the least possible amount of options on purpose as we want to keep it simple.

packages/nimiq-icons/src/flags/icons.json

@@ -1268,7 +1268,7 @@
 			"body": "<mask id=\"nimiq-flags-zw-hexagon-pbk987\" width=\"32\" height=\"28\" x=\"0\" y=\"2\" maskUnits=\"userSpaceOnUse\" style=\"mask-type:alpha\"><path fill=\"#fff\" d=\"M31.15 14.71 24.707 3.54a2.58 2.58 0 00-2.234-1.29H9.582c-.92 0-1.77.49-2.23 1.29L.907 14.71c-.46.8-.46 1.78 0 2.58l6.445 11.17c.46.8 1.31 1.29 2.23 1.29h12.89c.92 0 1.77-.49 2.23-1.29l6.445-11.17c.464-.8.464-1.78.004-2.58\"/></mask><g fill=\"none\"><g mask=\"url(#nimiq-flags-zw-hexagon-pbk987)\"><path fill=\"#6DA544\" d=\"M1.962 0H32v32H1.962z\"/><path fill=\"#FFDA44\" d=\"M3.613 4.581H32v4.582l-4.069 6.875 4.07 6.875v4.58H3.612z\"/><path fill=\"#D80027\" d=\"M8.25 9.162H32v4.582l-1.687 2.25L32 18.325v4.581H8.25z\"/><path fill=\"#EEE\" d=\"M0 0v32l17.488-16z\"/><path fill=\"#D80027\" d=\"m6.437 11.825 1.032 3.188h3.35l-2.713 1.975 1.038 3.187-2.713-1.969-2.712 1.969 1.037-3.187-2.712-1.976h3.35z\"/><path fill=\"#FFDA44\" d=\"m9.281 16.263-2.7-.957-.212-1.937a1.044 1.044 0 10-2.032.475l-.75.756h1.344c0 1.4-1.044 1.4-1.044 2.794l.575 1.387h3.482l.58-1.387q.086-.198.107-.413c.5-.2.65-.719.65-.719\"/><path fill=\"#333\" d=\"m1.963 0 13.75 13.75H32v4.575H15.638L1.962 32H0l16-16L0 0z\"/><path fill=\"url(#nimiq-flags-zw-hexagon-pbk987)\" d=\"M31.15 14.71 24.707 3.54a2.58 2.58 0 00-2.234-1.29H9.582c-.92 0-1.77.49-2.23 1.29L.907 14.71c-.46.8-.46 1.78 0 2.58l6.445 11.17c.46.8 1.31 1.29 2.23 1.29h12.89c.92 0 1.77-.49 2.23-1.29l6.445-11.17c.464-.8.464-1.78.004-2.58\"/></g><defs><radialGradient id=\"nimiq-flags-zw-hexagon-pbk987\" cx=\"0\" cy=\"0\" r=\"1\" gradientTransform=\"matrix(30.943 0 0 30.9452 23.829 29.395)\" gradientUnits=\"userSpaceOnUse\"><stop stop-color=\"#1D1D1B\" stop-opacity=\".3\"/><stop offset=\"1\" stop-color=\"#E9B213\" stop-opacity=\"0\"/></radialGradient></defs></g>"
 		}
 	},
-	"lastModified": 1759222558,
+	"lastModified": 1759234944,
 	"width": 32,
 	"height": 32
 }

packages/nimiq-icons/src/flags/info.json

@@ -2,7 +2,7 @@
 	"prefix": "nimiq-flags",
 	"name": "nimiq-flags",
 	"total": 422,
-	"version": "1.0.0-beta.105",
+	"version": "1.0.0-beta.107",
 	"author": {
 		"name": "onmax",
 		"url": "https://github.com/onmax"

packages/nimiq-icons/src/flags/package.json

@@ -2,7 +2,7 @@
 	"name": "nimiq-flags",
 	"description": "The Nimiq Flags as an iconify icon set.",
 	"version": "1.0.0-beta.107",
-	"iconSetVersion": "1.0.0-beta.105",
+	"iconSetVersion": "1.0.0-beta.107",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",

packages/nimiq-icons/src/icons/icons.json

@@ -1586,7 +1586,7 @@
 			"hidden": true
 		}
 	},
-	"lastModified": 1759222558,
+	"lastModified": 1759234944,
 	"width": 12,
 	"height": 12
 }

packages/nimiq-icons/src/icons/info.json

@@ -2,7 +2,7 @@
 	"prefix": "nimiq",
 	"name": "nimiq-icons",
 	"total": 84,
-	"version": "1.0.0-beta.105",
+	"version": "1.0.0-beta.107",
 	"author": {
 		"name": "onmax",
 		"url": "https://github.com/onmax"

packages/nimiq-icons/src/icons/package.json

@@ -2,7 +2,7 @@
 	"name": "nimiq-icons",
 	"description": "The Nimiq Icons as an iconify icon set.",
 	"version": "1.0.0-beta.107",
-	"iconSetVersion": "1.0.0-beta.105",
+	"iconSetVersion": "1.0.0-beta.107",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",

packages/nimiq-vitepress-theme/package.json

@@ -71,7 +71,6 @@
   "dependencies": {
     "@iconify-json/tabler": "catalog:icons",
     "@iconify-json/vscode-icons": "catalog:icons",
-    "@mdream/vite": "^0.11.0",
     "@nolebase/vitepress-plugin-git-changelog": "catalog:build",
     "@vueuse/core": "catalog:utils",
     "@vueuse/motion": "^3.0.3",
@@ -81,6 +80,7 @@
     "nimiq-icons": "workspace:*",
     "reka-ui": "catalog:frontend",
     "vaul-vue": "catalog:prod",
+    "vitepress-plugin-llms": "^1.7.5",
     "vue": "catalog:frontend",
     "vue-router": "catalog:frontend",
     "vue-sonner": "^1.1.4"

packages/nimiq-vitepress-theme/src/composables/useSourceCode.ts

@@ -1,21 +1,136 @@
-import { useClipboard } from '@vueuse/core'
 import { join } from 'pathe'
 import { useData } from 'vitepress'
-import { computed, ref } from 'vue'
+import { computed, onBeforeUnmount, ref } from 'vue'
 import { toast } from 'vue-sonner'
 import { useChangelog } from './useChangelog'
 import { useNimiqConfig } from './useNimiqConfig'
 
 export function useSourceCode() {
-  const { page, frontmatter } = useData()
+  const { page, frontmatter, site } = useData()
   const { repoURL } = useChangelog()
   const nimiqConfig = useNimiqConfig()
 
-  // Use a safer approach for SSR compatibility
-  const clipboardResult = typeof window !== 'undefined'
-    ? useClipboard()
-    : { copy: async () => {}, copied: ref(false), isSupported: ref(false) }
-  const { copy, copied, isSupported } = clipboardResult
+  if (typeof window === 'undefined') {
+    const fallbackCopied = ref(false)
+    const fallbackSupported = ref(false)
+    const emptyString = computed(() => '')
+    const copyOptions = computed(() => ({
+      markdownLink: false,
+      viewMarkdown: false,
+      chatgpt: false,
+      claude: false,
+    }))
+
+    return {
+      showSourceCode: computed(() => false),
+      showCopyMarkdown: computed(() => false),
+      editUrl: emptyString,
+      sourceCodeUrl: emptyString,
+      sourceCodeLabel: computed(() => 'View Source'),
+      copyMarkdownContent: async () => {},
+      copied: fallbackCopied,
+      isSupported: fallbackSupported,
+      copyMarkdownLink: async () => {},
+      chatGPTUrl: emptyString,
+      claudeUrl: emptyString,
+      viewAsMarkdown: () => {},
+      copyOptionsConfig: copyOptions,
+      hasDropdownOptions: computed(() => false),
+    }
+  }
+
+  const copied = ref(false)
+  const isSupported = ref(false)
+  let resetTimer: ReturnType<typeof setTimeout> | undefined
+
+  const determineSupport = () => {
+    if (typeof window === 'undefined') {
+      isSupported.value = false
+      return
+    }
+
+    const nav = window.navigator
+    const hasClipboardAPI = !!nav?.clipboard?.writeText
+    const hasLegacySupport = typeof document !== 'undefined' && typeof document.queryCommandSupported === 'function'
+      && document.queryCommandSupported('copy')
+
+    isSupported.value = hasClipboardAPI || hasLegacySupport
+  }
+
+  const resetCopiedFlag = () => {
+    if (resetTimer)
+      clearTimeout(resetTimer)
+    resetTimer = setTimeout(() => {
+      copied.value = false
+      resetTimer = undefined
+    }, 1500)
+  }
+
+  const copy = async (text: string) => {
+    if (typeof window === 'undefined')
+      throw new Error('Clipboard not available during SSR')
+
+    const nav = window.navigator
+
+    if (nav?.clipboard?.writeText) {
+      await nav.clipboard.writeText(text)
+    }
+    else if (typeof document !== 'undefined' && document.body) {
+      const textarea = document.createElement('textarea')
+      textarea.value = text
+      textarea.setAttribute('readonly', 'true')
+      textarea.style.position = 'absolute'
+      textarea.style.left = '-9999px'
+      document.body.appendChild(textarea)
+      textarea.select()
+      const successful = document.execCommand?.('copy') ?? false
+      document.body.removeChild(textarea)
+      if (!successful)
+        throw new Error('Clipboard copy failed')
+    }
+    else {
+      throw new Error('Clipboard API not supported')
+    }
+
+    copied.value = true
+    resetCopiedFlag()
+  }
+
+  if (typeof window !== 'undefined')
+    determineSupport()
+
+  onBeforeUnmount(() => {
+    if (resetTimer)
+      clearTimeout(resetTimer)
+  })
+
+  const generatedMarkdownPath = computed(() => {
+    const filePath = page.value.relativePath || page.value.filePath || 'index.md'
+
+    if (filePath === 'index.md')
+      return '/index.md'
+
+    if (filePath.endsWith('/index.md')) {
+      const trimmed = filePath.slice(0, -'/index.md'.length)
+      return `/${trimmed}.md`
+    }
+
+    return `/${filePath}`
+  })
+
+  const markdownUrl = computed(() => {
+    const base = site.value.base?.replace(/\/$/, '') ?? ''
+    const path = generatedMarkdownPath.value
+    return `${base}${path}`
+  })
+
+  const getAbsoluteMarkdownUrl = () => {
+    if (typeof window === 'undefined')
+      return ''
+
+    const origin = window.location.origin
+    return new URL(markdownUrl.value, origin).href
+  }
 
   const showSourceCode = computed(() => {
     if (!isSupported.value)
@@ -112,11 +227,8 @@ export function useSourceCode() {
         return
       }
 
-      const currentPath = window.location.pathname
-      const markdownPath = currentPath.replace(/\.html$/, '.md').replace(/\/$/, '/index.md')
-      const markdownUrl = `${window.location.origin}${markdownPath}`
+      const response = await fetch(markdownUrl.value)
 
-      const response = await fetch(markdownUrl)
       if (!response.ok) {
         throw new Error(`HTTP ${response.status}: ${response.statusText}`)
       }
@@ -139,10 +251,7 @@ export function useSourceCode() {
       }
 
       const pageTitle = page.value.title || document.title || 'Documentation Page'
-      const currentPath = window.location.pathname
-      const markdownPath = currentPath.replace(/\.html$/, '.md').replace(/\/$/, '/index.md')
-      const markdownUrl = `${window.location.origin}${markdownPath}`
-      const markdownLink = `[${pageTitle}](${markdownUrl})`
+      const markdownLink = `[${pageTitle}](${getAbsoluteMarkdownUrl()})`
 
       await copy(markdownLink)
       toast.success('Markdown link copied to clipboard')
@@ -154,34 +263,37 @@ export function useSourceCode() {
   }
 
   const getRawMarkdownUrl = () => {
-    let rawUrl = sourceCodeUrl.value
+    const absoluteUrl = getAbsoluteMarkdownUrl()
 
-    if (rawUrl.includes('github.com') && rawUrl.includes('/blob/')) {
-      rawUrl = rawUrl
-        .replace('github.com', 'raw.githubusercontent.com')
-        .replace('/blob/', '/')
-    }
+    if (!absoluteUrl)
+      return ''
 
-    return encodeURIComponent(rawUrl)
+    return encodeURIComponent(absoluteUrl)
   }
 
   const chatGPTUrl = computed(() => {
     const rawUrl = getRawMarkdownUrl()
+    if (!rawUrl)
+      return ''
+
     const message = `Read ${rawUrl} so I can ask questions about it.`
     const encodedMessage = encodeURIComponent(message)
     return `https://chatgpt.com/?hints=search&q=${encodedMessage}`
   })
 
   const claudeUrl = computed(() => {
     const rawUrl = getRawMarkdownUrl()
+    if (!rawUrl)
+      return ''
+
     const message = `Read ${rawUrl} so I can ask questions about it.`
     const encodedMessage = encodeURIComponent(message)
     return `https://claude.ai/new?q=${encodedMessage}`
   })
 
   const viewAsMarkdown = () => {
     if (typeof window !== 'undefined') {
-      window.open(sourceCodeUrl.value, '_blank', 'noopener,noreferrer')
+      window.open(getAbsoluteMarkdownUrl() || markdownUrl.value, '_blank', 'noopener,noreferrer')
     }
   }