fix: 🐞 修复 Demo 容器引用的组件没有打包被打包，修复浏览器无法回退上一页问题，主题版权链接更改为 GitHub 地址

Author: Kele-Bingtang

docs/01.指南/10.使用/05.Markdown 拓展.md

@@ -660,4 +660,8 @@ Demo 容器默认在项目根目录的 `examples` 目录下寻找 `button-demo.v
 │  ├─ button-demo.vue
 ```
 
-如果您需要更改 `examples` 目录，请查看 [插件配置](/reference/plugin-config#demo)。
+::: tip
+暂不支持通过配置项更改 `examples` 为其他目录。
+:::
+
+Demo 容器的更多配置请查看 [Demo 容器](/reference/plugin-config#demo)。

docs/01.指南/20.相关/15.笔记技巧.md

@@ -307,8 +307,6 @@ Demo 容器默认在项目根目录的 `examples` 目录下寻找 `button-demo.v
 │  ├─ button-demo.vue
 ```
 
-如果您需要更改 `examples` 目录，请查看 [插件配置](/reference/plugin-config#demo)。
-
 ## 自定义容器
 
 自定义容器可以通过它们的类型、标题和内容来定义。
@@ -407,7 +405,7 @@ Markdown 拓展
 ::: details 点我查看代码
 
 ```js
-console.log("Hello, VitePress!");
+console.log("Hello, Vitepress!");
 ```
 
 :::

docs/10.配置/01.主题配置/40.插件配置.md

@@ -344,7 +344,6 @@ import { defineTeekConfig } from "vitepress-theme-teek/config";
 const teekConfig = defineTeekConfig({
   markdown: {
     demo: {
-      path: "examples", // Demo 组件路径，基于 .vitepress 目录层级添加
       playgroundUrl: "", // Playground 链接
       playgroundMainFileName: "App.vue", // Playground 主文件名
       githubUrl: "", // Github 链接
@@ -364,12 +363,6 @@ interface Markdown {
    * demo 插件配置
    */
   demo?: {
-    /**
-     * Demo 组件路径，基于 .vitepress 目录层级添加
-     *
-     * @default 'examples'
-     */
-    path?: string;
     /**
      * Playground 链接
      */

docs/examples/button-demo.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts" name="Demo1"></script>
 
 <template>
-  <button class="tk-button">primary</button>
+  <button class="tk-button">primary1234</button>
 </template>
 
 <style lang="scss" scoped>

plugins/vitepress-plugin-permalink/CHANGELOG.md

@@ -1,5 +1,11 @@
 # vitepress-plugin-permalink
 
+## 1.0.16
+
+### Patch Changes
+
+- 修复跳转 permalink 后无法回退问题
+
 ## 1.0.15
 
 ### Patch Changes

plugins/vitepress-plugin-permalink/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vitepress-plugin-permalink",
   "type": "module",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "扫描 Markdown 文档，生成永久链接",
   "author": {
     "name": "teeker",

plugins/vitepress-plugin-permalink/src/usePermalink.ts

@@ -117,8 +117,6 @@ export default function usePermalink() {
 
       if (filePath) {
         const targetUrl = base + filePath + search + hash;
-        // router.go 前清除当前历史记录，防止 router.go 后浏览器返回时回到当前历史记录时，又重定向过去，如此反复循环
-        history.replaceState(history.state || null, "", targetUrl);
         router.go(targetUrl);
 
         // 阻止本次路由跳转

vitepress-theme-teek/package.json

@@ -51,7 +51,7 @@
     "vitepress-plugin-doc-analysis": "^1.0.10",
     "vitepress-plugin-file-content-loader": "^1.0.9",
     "vitepress-plugin-md-h1": "^1.0.8",
-    "vitepress-plugin-permalink": "^1.0.15",
+    "vitepress-plugin-permalink": "^1.0.16",
     "vitepress-plugin-sidebar-resolve": "^1.0.8"
   },
   "devDependencies": {

vitepress-theme-teek/src/components/DemoCode/src/index.vue

@@ -7,6 +7,7 @@ import Icon from "../../Icon";
 import TransitionCollapse from "../../TransitionCollapse";
 import type { DemoCodeProps } from "./demoCode";
 import { playgroundIcon, githubIcon, copyIcon, codeIcon, caretTopIcon } from "../../../assets/icons";
+import { cs } from "element-plus/es/locale";
 
 defineOptions({ name: "DemoCode" });
 
@@ -31,13 +32,15 @@ const decodeSource = computed(() => decodeURIComponent(props.source));
 const decodeRawSource = computed(() => decodeURIComponent(props.rawSource));
 const decodedDescription = computed(() => decodeURIComponent(props.description));
 
+// 预加载 Demo 组件，防止 Vitepress 打包时不包含 Demo 组件
+const moduleFiles = (import.meta as any).glob("/examples/**/*.vue", { eager: true });
+
 const DemoComponent = defineAsyncComponent(async () => {
   try {
-    // / 表示从 .vitepress 目录层级开始
-    return await import(/* @vite-ignore */ withBase(`/${props.path}`));
+    const key = Object.keys(moduleFiles).find(i => i.endsWith(`/${props.path}`)) as string;
+    return moduleFiles[key];
   } catch (error) {
-    console.error(`[Teek Error] Failed to load component: '${props.path}'`, error);
-    return null;
+    console.error(`[Teek Error] Failed to load component: '/${props.path}'`, error);
   }
 });
 

vitepress-theme-teek/src/components/Footer/src/index.vue

@@ -25,7 +25,7 @@ const footerData = computed(() => {
     data.push({
       name: "Theme By Teek",
       icon: themeIcon,
-      link: "http://vp.teek.top/",
+      link: "https://github.com/Kele-Bingtang/vitepress-theme-teek",
       // 可覆盖上面的配置项
       ...theme,
     });

vitepress-theme-teek/src/config/types/markdown.ts

@@ -26,12 +26,6 @@ export interface Markdown {
 }
 
 export interface Demo {
-  /**
-   * Demo 组件路径，基于 .vitepress 目录层级添加
-   *
-   * @default 'examples'
-   */
-  path?: string;
   /**
    * Playground 链接
    */

vitepress-theme-teek/src/markdown/plugins/demo.ts

@@ -3,7 +3,7 @@ import type { Renderer, Token } from "markdown-it";
 import type { SiteConfig } from "vitepress";
 import container from "markdown-it-container";
 import { readFileSync } from "fs";
-import { join, resolve, normalize } from "path";
+import { join, resolve, posix } from "path";
 import type { Demo } from "../../config";
 
 interface ContainerOpts {
@@ -13,11 +13,10 @@ interface ContainerOpts {
 }
 
 const demoPlugin = (md: MarkdownIt, option: Demo = {}) => {
-  console.log(option);
   const siteConfig: SiteConfig = (globalThis as any).VITEPRESS_CONFIG;
   const srcDir = siteConfig.srcDir;
-  const { path = "examples" } = option;
-  const demoPath = join(srcDir, path || "");
+  const path = "examples";
+  const demoPath = join(srcDir, path);
 
   const options: ContainerOpts = {
     validate(params) {
@@ -34,7 +33,6 @@ const demoPlugin = (md: MarkdownIt, option: Demo = {}) => {
         const containerContent = sourceFileToken.children?.[0].content ?? "";
         // 确保文件路径带 .vue
         const sourceFile = containerContent ? `${containerContent.replace(/.vue$/, "")}.vue` : "";
-        const sourceRelativeFile = normalize(join(path, sourceFile));
 
         if (sourceFile && sourceFileToken.type === "inline") {
           source = readFileSync(resolve(demoPath, sourceFile), "utf-8");
@@ -43,7 +41,7 @@ const demoPlugin = (md: MarkdownIt, option: Demo = {}) => {
 
         return `<TkDemoCode source="${encodeURIComponent(
           md.render(`\`\`\` vue\n${source}\`\`\``)
-        )}" path="${sourceRelativeFile}" raw-source="${encodeURIComponent(
+        )}" path="${posix.join(path, sourceFile)}" raw-source="${encodeURIComponent(
           source
         )}" description="${encodeURIComponent(md.render(description))}" demo="${encodeURIComponent(JSON.stringify(option))}">`;
       } else return "</TkDemoCode>";