feat: add copy page as markdown feature

onmax · onmax · commit 869fa54434f5 · 2025-09-30T09:19:09.000+02:00
diff --git a/docs/nimiq-css/utilities.md b/docs/nimiq-css/utilities.md
@@ -2,7 +2,7 @@
 
 A set of CSS utility classes for the most common use cases.
 
-[Source code](https://github.com/onmax/nimiq-ui/tree/main/packages/nimiq-css/src/css/utilities.css){.nq-arrow .nq-pill-tertiary .nq-raw}
+<NqLinks :item="{ label: 'Source code', href: 'https://github.com/onmax/nimiq-ui/tree/main/packages/nimiq-css/src/css/utilities.css' }" />
 
 ## Usage in Native CSS
 
diff --git a/packages/nimiq-icons/src/flags/icons.json b/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": 1758697349,
+	"lastModified": 1759216589,
 	"width": 32,
 	"height": 32
 }
diff --git a/packages/nimiq-icons/src/flags/info.json b/packages/nimiq-icons/src/flags/info.json
@@ -2,7 +2,7 @@
 	"prefix": "nimiq-flags",
 	"name": "nimiq-flags",
 	"total": 422,
-	"version": "1.0.0-beta.97",
+	"version": "1.0.0-beta.100",
 	"author": {
 		"name": "onmax",
 		"url": "https://github.com/onmax"
diff --git a/packages/nimiq-icons/src/flags/package.json b/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.100",
-	"iconSetVersion": "1.0.0-beta.97",
+	"iconSetVersion": "1.0.0-beta.100",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",
diff --git a/packages/nimiq-icons/src/icons/icons.json b/packages/nimiq-icons/src/icons/icons.json
@@ -1586,7 +1586,7 @@
 			"hidden": true
 		}
 	},
-	"lastModified": 1758697349,
+	"lastModified": 1759216589,
 	"width": 12,
 	"height": 12
 }
diff --git a/packages/nimiq-icons/src/icons/info.json b/packages/nimiq-icons/src/icons/info.json
@@ -2,7 +2,7 @@
 	"prefix": "nimiq",
 	"name": "nimiq-icons",
 	"total": 84,
-	"version": "1.0.0-beta.97",
+	"version": "1.0.0-beta.100",
 	"author": {
 		"name": "onmax",
 		"url": "https://github.com/onmax"
diff --git a/packages/nimiq-icons/src/icons/package.json b/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.100",
-	"iconSetVersion": "1.0.0-beta.97",
+	"iconSetVersion": "1.0.0-beta.100",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",
diff --git a/packages/nimiq-vitepress-theme/build.config.ts b/packages/nimiq-vitepress-theme/build.config.ts
@@ -54,7 +54,6 @@ export default defineBuildConfig({
       const srcDir = join(packageDir, 'src')
       const distFile = join(packageDir, 'dist/assets/uno.css')
       const config = join(packageDir, 'uno.config.ts')
-      console.log({ config, srcDir, distFile })
       await execAsync(`unocss "${srcDir}/**/*.vue" -o "${distFile}" --config "${config}"`, { cwd: packageDir })
     },
   },
diff --git a/packages/nimiq-vitepress-theme/package.json b/packages/nimiq-vitepress-theme/package.json
@@ -74,7 +74,9 @@
     "@nolebase/vitepress-plugin-git-changelog": "catalog:build",
     "@vueuse/core": "catalog:utils",
     "@vueuse/motion": "^3.0.3",
+    "fast-glob": "^3.3.3",
     "mark.js": "catalog:prod",
+    "mdream": "^0.11.0",
     "minisearch": "catalog:prod",
     "motion-v": "^1.6.1",
     "nimiq-icons": "workspace:*",
diff --git a/packages/nimiq-vitepress-theme/src/composables/useSourceCode.ts b/packages/nimiq-vitepress-theme/src/composables/useSourceCode.ts
@@ -107,15 +107,16 @@ export function useSourceCode() {
 
   const copyMarkdownContent = async () => {
     try {
-      let rawUrl = sourceCodeUrl.value
-
-      if (rawUrl.includes('github.com') && rawUrl.includes('/blob/')) {
-        rawUrl = rawUrl
-          .replace('github.com', 'raw.githubusercontent.com')
-          .replace('/blob/', '/')
+      if (typeof window === 'undefined') {
+        toast.error('Copy functionality not available during server-side rendering')
+        return
       }
 
-      const response = await fetch(rawUrl)
+      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)
       if (!response.ok) {
         throw new Error(`HTTP ${response.status}: ${response.statusText}`)
       }
@@ -126,7 +127,6 @@ export function useSourceCode() {
     }
     catch (error) {
       console.error('Failed to copy markdown content:', error)
-      console.error('Source URL was:', sourceCodeUrl.value)
       toast.error('Failed to copy page content')
     }
   }
diff --git a/packages/nimiq-vitepress-theme/src/index.ts b/packages/nimiq-vitepress-theme/src/index.ts
@@ -1,6 +1,7 @@
 import type { NimiqVitepressThemeConfig } from 'nimiq-vitepress-theme/types.js'
 import type { UserConfig } from 'vitepress'
 import { defineConfig } from 'vitepress'
+import { generateMarkdownFiles } from './vite/markdown-generator'
 
 export function defineNimiqVitepressConfig<T = NimiqVitepressThemeConfig>(config: UserConfig<T>): UserConfig<T> {
   const defaultConfig: UserConfig<T> = {
@@ -11,7 +12,9 @@ export function defineNimiqVitepressConfig<T = NimiqVitepressThemeConfig>(config
         light: 'vitesse-light',
         dark: 'vitesse-dark',
       },
-      // languages: ['vue', 'vue-html', 'js', 'ts', 'markdown', 'json', 'rs'],
+    },
+    buildEnd: async (siteConfig) => {
+      await generateMarkdownFiles(siteConfig.outDir)
     },
   }
 
diff --git a/packages/nimiq-vitepress-theme/src/scripts/generate-markdown.ts b/packages/nimiq-vitepress-theme/src/scripts/generate-markdown.ts
@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import process from 'node:process'
+import { resolve } from 'pathe'
+import { generateMarkdownFiles } from '../vite/markdown-generator'
+
+const distDir = process.argv[2] || resolve(process.cwd(), '.vitepress/dist')
+
+generateMarkdownFiles(distDir)
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error('Failed to generate markdown files:', error)
+    process.exit(1)
+  })
diff --git a/packages/nimiq-vitepress-theme/src/vite/markdown-generator.ts b/packages/nimiq-vitepress-theme/src/vite/markdown-generator.ts
@@ -0,0 +1,56 @@
+import { readFile, writeFile } from 'node:fs/promises'
+import process from 'node:process'
+import consola from 'consola'
+import fg from 'fast-glob'
+import { htmlToMarkdown } from 'mdream'
+import { basename, relative, resolve } from 'pathe'
+
+export async function generateMarkdownFiles(distDir?: string) {
+  const vitepressOutDir = distDir || resolve(process.cwd(), '.vitepress/dist')
+
+  consola.start('Generating markdown files from HTML...')
+
+  try {
+    const htmlFiles = await fg('**/*.html', {
+      cwd: vitepressOutDir,
+      absolute: true,
+      ignore: ['**/node_modules/**'],
+    })
+
+    consola.info(`Found ${htmlFiles.length} HTML files in ${vitepressOutDir}`)
+
+    if (htmlFiles.length === 0) {
+      consola.warn('No HTML files found. Skipping markdown generation.')
+      return
+    }
+
+    let converted = 0
+    let failed = 0
+
+    for (const htmlFile of htmlFiles) {
+      try {
+        const html = await readFile(htmlFile, 'utf-8')
+        const markdown = await htmlToMarkdown(html)
+        const mdFile = htmlFile.replace(/\.html$/, '.md')
+
+        await writeFile(mdFile, markdown, 'utf-8')
+
+        const relativePath = relative(vitepressOutDir, htmlFile)
+        consola.debug(`Generated: ${relativePath} -> ${basename(mdFile)}`)
+
+        converted++
+      }
+      catch (error) {
+        failed++
+        const relativePath = relative(vitepressOutDir, htmlFile)
+        consola.error(`Failed to convert ${relativePath}:`, error)
+      }
+    }
+
+    consola.success(`Generated ${converted} markdown files (${failed} failed)`)
+  }
+  catch (error) {
+    consola.error('Error generating markdown files:', error)
+    throw error
+  }
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1268,7 +1268,7 @@`
`1268`	`1268`	"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>"
`1269`	`1269`	`}`
`1270`	`1270`	`},`
`1271`		`- "lastModified": 1758697349,`
	`1271`	`+ "lastModified": 1759216589,`
`1272`	`1272`	`"width": 32,`
`1273`	`1273`	`"height": 32`
`1274`	`1274`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1586,7 +1586,7 @@`
`1586`	`1586`	`"hidden": true`
`1587`	`1587`	`}`
`1588`	`1588`	`},`
`1589`		`- "lastModified": 1758697349,`
	`1589`	`+ "lastModified": 1759216589,`
`1590`	`1590`	`"width": 12,`
`1591`	`1591`	`"height": 12`
`1592`	`1592`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,15 +107,16 @@ export function useSourceCode() {`
`107`	`107`
`108`	`108`	`const copyMarkdownContent = async () => {`
`109`	`109`	`try {`
`110`		`- let rawUrl = sourceCodeUrl.value`
`111`		`-`
`112`		`- if (rawUrl.includes('github.com') && rawUrl.includes('/blob/')) {`
`113`		`- rawUrl = rawUrl`
`114`		`- .replace('github.com', 'raw.githubusercontent.com')`
`115`		`- .replace('/blob/', '/')`
	`110`	`+ if (typeof window === 'undefined') {`
	`111`	`+ toast.error('Copy functionality not available during server-side rendering')`
	`112`	`+ return`
`116`	`113`	`}`
`117`	`114`
`118`		`- const response = await fetch(rawUrl)`
	`115`	`+ const currentPath = window.location.pathname`
	`116`	`+ const markdownPath = currentPath.replace(/\.html$/, '.md').replace(/\/$/, '/index.md')`
	`117`	+ const markdownUrl = `${window.location.origin}${markdownPath}`
	`118`	`+`
	`119`	`+ const response = await fetch(markdownUrl)`
`119`	`120`	`if (!response.ok) {`
`120`	`121`	throw new Error(`HTTP ${response.status}: ${response.statusText}`)
`121`	`122`	`}`
`@@ -126,7 +127,6 @@ export function useSourceCode() {`
`126`	`127`	`}`
`127`	`128`	`catch (error) {`
`128`	`129`	`console.error('Failed to copy markdown content:', error)`
`129`		`- console.error('Source URL was:', sourceCodeUrl.value)`
`130`	`130`	`toast.error('Failed to copy page content')`
`131`	`131`	`}`
`132`	`132`	`}`