@wot-ui/vitepress-theme 2.0.0-alpha.15 → 2.0.0-alpha.16

package/dist/index.d.ts

@@ -6,9 +6,15 @@ import './theme/styles/vars.css';
 import './theme/styles/custom.css';
 declare global {
     interface Window {
+        /**
+         * 百度统计全局队列。
+         */
         _hmt: any[];
     }
 }
+/**
+ * 创建 Wot VitePress 主题实例。
+ */
 export declare function createWotVitePressTheme(options?: WotVitePressThemeOptions): Theme;
 declare const theme: Theme;
 export default theme;

package/dist/index.js

@@ -19,7 +19,8 @@ function resolveThemeOptions(options = {}) {
     team: options.team ?? false,
     friendly: options.friendly ?? false,
     cases: options.cases ?? false,
-    demoIframe: options.demoIframe ?? false
+    demoIframe: options.demoIframe ?? false,
+    specialSponsor: options.specialSponsor ?? false
   };
 }
 function enhanceAppWithOptions(ctx, options) {

package/dist/theme/components/AsideSponsors.vue

@@ -1,8 +1,8 @@
 <script setup lang="ts">
 import { computed } from 'vue'
-import { useAdSponsor } from '../composables/adSponsor'
+import { useSpecialSponsor } from '../composables/specialSponsor'
 
-const { data } = useAdSponsor()
+const { data } = useSpecialSponsor()
 
 // 分离超级赞助和金牌赞助
 const superSponsors = computed(() => {

package/dist/theme/components/SpecialSponsor.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
 import { computed } from 'vue'
-import { useAdSponsor } from '../composables/adSponsor'
+import { useSpecialSponsor } from '../composables/specialSponsor'
 
 interface Props {
   title?: string
@@ -10,7 +10,7 @@ withDefaults(defineProps<Props>(), {
   title: '铂金赞助商'
 })
 
-const { data } = useAdSponsor()
+const { data } = useSpecialSponsor()
 
 // 获取第一个铂金赞助商
 const platinumSponsor = computed(() => {

package/dist/theme/components/VPIframe.vue

@@ -79,9 +79,11 @@ const emit = defineEmits<{
 
 const route = useRoute()
 const vitepressData = useData()
+const { frontmatter } = vitepressData
 const themeOptions = inject(wotThemeOptionsKey)
 const demoIframeOptions = themeOptions?.demoIframe
 const assetBase = demoIframeOptions && demoIframeOptions.assetBase ? demoIframeOptions.assetBase : '/wxqrcode'
+const qrcodeEnabled = demoIframeOptions && demoIframeOptions.enabled !== false
 
 const href = computed(() => {
   const path = route.path
@@ -89,10 +91,21 @@ const href = computed(() => {
 
   if (!paths.length) return baseUrl.value
 
-  return baseUrl.value + `subPages/${kebabToCamel(paths[paths.length - 1])}/Index`
+  const pageName = paths[paths.length - 1]
+  const iframeFormatter = frontmatter.value.iframeFormatter
+
+  if (typeof iframeFormatter === 'function') {
+    return baseUrl.value + iframeFormatter(pageName)
+  } else if (typeof iframeFormatter === 'string') {
+    return baseUrl.value + iframeFormatter.replace('{name}', pageName).replace('{camelName}', kebabToCamel(pageName))
+  }
+
+  return baseUrl.value + `subPages/${kebabToCamel(pageName)}/Index`
 })
 
 const qrcode = computed(() => {
+  if (!qrcodeEnabled) return ''
+
   const path = route.path
   const paths = path ? path.split('.')[0].split('/') : []
   if (!paths.length) return ''

package/dist/theme/composables/cases.js

@@ -13,16 +13,28 @@ function useCaseData() {
     const fetchData = async () => {
       for (const url of urls) {
         try {
-          const path = "/cases.json";
-          const response = await axios.get(url + path + "?t=" + Date.now(), {
+          const response = await axios.get(url + "?t=" + Date.now(), {
             timeout: 5e3
             // 设置5秒超时
           });
           const data2 = response.data && response.data.data ? response.data.data : [];
+          const getFullImageUrl = (image, baseUrl) => {
+            if (!image)
+              return "";
+            if (image.startsWith("http://") || image.startsWith("https://")) {
+              return image;
+            }
+            try {
+              const { origin } = new URL(baseUrl);
+              return origin + image;
+            } catch {
+              return baseUrl + image;
+            }
+          };
           return data2.map((item) => {
             return {
               name: item.name,
-              image: item.image ? url + item.image : "",
+              image: getFullImageUrl(item.image, url),
               description: item.description
             };
           });

package/dist/theme/composables/{adSponsor.d.ts → specialSponsor.d.ts}

@@ -9,7 +9,7 @@ export interface Sponsors {
     size?: GridSize;
     items: Sponsor[];
 }
-export declare function useAdSponsor(): {
+export declare function useSpecialSponsor(): {
     data: import("vue").Ref<{
         tier?: string;
         size?: GridSize;

package/dist/theme/composables/{adSponsor.js → specialSponsor.js}

@@ -1,9 +1,15 @@
-import { ref, onMounted } from "vue";
+import { ref, onMounted, inject } from "vue";
 import axios from "axios";
+import { wotThemeOptionsKey } from "../options.js";
 const data = ref([]);
-function useAdSponsor() {
+function useSpecialSponsor() {
+  const options = inject(wotThemeOptionsKey);
   onMounted(async () => {
-    const urls = ["https://sponsor.wot-ui.cn/sponsor.json", "https://wot-sponsors.pages.dev/sponsor.json"];
+    const sponsorOptions = options?.specialSponsor;
+    if (!sponsorOptions || data.value.length) {
+      return;
+    }
+    const urls = sponsorOptions.urls || [];
     const fetchData = async () => {
       for (const url of urls) {
         try {
@@ -25,5 +31,5 @@ function useAdSponsor() {
   };
 }
 export {
-  useAdSponsor
+  useSpecialSponsor
 };

package/dist/theme/composables/team.js

@@ -28,7 +28,7 @@ function useTeam() {
     const fetchData = async () => {
       for (const url of urls) {
         try {
-          const response = await axios.get(url + "/team.json?t=" + Date.now(), {
+          const response = await axios.get(url + "?t=" + Date.now(), {
             timeout: 5e3
           });
           const members = response.data && response.data.members ? response.data.members : [];

package/dist/types.d.ts

@@ -1,86 +1,296 @@
 import type { DefaultTheme, HeadConfig, UserConfig } from 'vitepress';
 import type { PluginOption } from 'vite';
+/**
+ * 主题埋点配置。
+ */
 export interface WotThemeAnalyticsOptions {
+    /**
+     * 是否在路由切换后上报百度统计。
+     */
     trackBaiduRoute?: boolean;
 }
+/**
+ * 顶部横幅配置。
+ */
 export interface WotThemeBannerOptions {
+    /**
+     * 横幅图片地址列表。
+     */
     urls: string[];
 }
+/**
+ * 侧边赞助位配置。
+ */
 export interface WotThemeSponsorOptions {
+    /**
+     * 赞助图片地址列表。
+     */
     urls: string[];
 }
+/**
+ * 广告位配置。
+ */
 export interface WotThemeAdsOptions {
+    /**
+     * WwAds 广告位 ID。
+     */
     wwadsId?: string;
+    /**
+     * 自定义广告素材地址列表。
+     */
     urls?: string[];
 }
+/**
+ * 团队成员展示配置。
+ */
 export interface WotThemeTeamOptions {
+    /**
+     * 团队成员数据地址列表。
+     */
     urls: string[];
 }
+/**
+ * 友情链接配置。
+ */
 export interface WotThemeFriendlyOptions {
+    /**
+     * 友情链接数据地址列表。
+     */
     urls: string[];
 }
+/**
+ * 案例展示配置。
+ */
 export interface WotThemeCasesOptions {
+    /**
+     * 案例数据地址列表。
+     */
     urls: string[];
 }
+/**
+ * Demo iframe 展示配置。
+ */
 export interface WotThemeDemoIframeOptions {
+    /**
+     * iframe 资源基础路径。
+     */
     assetBase?: string;
+    /**
+     * 是否启用二维码。
+     */
+    enabled?: boolean;
 }
+/**
+ * 主题运行时可选能力配置。
+ */
 export interface WotVitePressThemeOptions {
+    /**
+     * 埋点能力配置，传入 false 表示关闭。
+     */
     analytics?: false | WotThemeAnalyticsOptions;
+    /**
+     * 顶部横幅配置，传入 false 表示关闭。
+     */
     banner?: false | WotThemeBannerOptions;
+    /**
+     * 赞助位配置，传入 false 表示关闭。
+     */
     sponsors?: false | WotThemeSponsorOptions;
+    /**
+     * 特别赞助位配置，传入 false 表示关闭。
+     */
+    specialSponsor?: false | WotThemeSponsorOptions;
+    /**
+     * 广告位配置，传入 false 表示关闭。
+     */
     ads?: false | WotThemeAdsOptions;
+    /**
+     * 团队成员模块配置，传入 false 表示关闭。
+     */
     team?: false | WotThemeTeamOptions;
+    /**
+     * 友情链接模块配置，传入 false 表示关闭。
+     */
     friendly?: false | WotThemeFriendlyOptions;
+    /**
+     * 案例模块配置，传入 false 表示关闭。
+     */
     cases?: false | WotThemeCasesOptions;
+    /**
+     * Demo iframe 配置，传入 false 表示关闭。
+     */
     demoIframe?: false | WotThemeDemoIframeOptions;
 }
+/**
+ * LLM 文本导出功能配置。
+ */
 export interface WotLlmsFeatureOptions {
+    /**
+     * 生成的站点域名。
+     */
     domain: string;
+    /**
+     * 需要忽略的文档路径列表。
+     */
     ignoreFiles?: string[];
 }
+/**
+ * Markdown 组件源码链接配置。
+ */
 export interface WotMdComponentLinksOptions {
+    /**
+     * 仓库源码地址前缀。
+     */
     repoUrl: string;
+    /**
+     * Demo 源码根目录。
+     */
     demoSourceRoot: string;
+    /**
+     * 组件源码根目录。
+     */
     componentSourceRoot: string;
 }
+/**
+ * Markdown SCSS 变量文档生成配置。
+ */
 export interface WotMdScssVarsOptions {
+    /**
+     * 组件样式源码根目录。
+     */
     componentScssRoot: string;
+    /**
+     * 文档组件名到实际组件名的映射表。
+     */
     componentMap?: Record<string, string[]>;
 }
+/**
+ * 虚拟版本数据插件配置。
+ */
 export interface WotVirtualVersionDataOptions {
+    /**
+     * 文档根目录。
+     */
     docsRoot?: string;
 }
+/**
+ * Markdown 增强能力配置集合。
+ */
 export interface WotMarkdownSourceOptions {
+    /**
+     * 组件源码链接能力配置。
+     */
     componentLinks?: false | WotMdComponentLinksOptions;
+    /**
+     * SCSS 变量文档能力配置。
+     */
     scssVars?: false | WotMdScssVarsOptions;
+    /**
+     * 是否开启版本徽标。
+     */
     versionBadge?: boolean;
+    /**
+     * 虚拟版本数据能力配置。
+     */
     virtualVersionData?: false | WotVirtualVersionDataOptions;
 }
+/**
+ * VitePress 额外特性配置集合。
+ */
 export interface WotVitePressFeatureOptions {
+    /**
+     * LLM 文本导出能力配置。
+     */
     llms?: false | WotLlmsFeatureOptions;
+    /**
+     * 静态资源压缩配置。
+     */
     compression?: false | Record<string, unknown>;
 }
+/**
+ * 创建 Wot VitePress 配置时接收的顶层参数。
+ */
 export interface WotVitePressConfigOptions {
+    /**
+     * 站点标题。
+     */
     title: string;
+    /**
+     * 站点描述。
+     */
     description: string;
+    /**
+     * 额外 head 配置。
+     */
     head?: HeadConfig[];
+    /**
+     * 国际化语言包配置。
+     */
     locales?: UserConfig['locales'];
+    /**
+     * 默认主题配置。
+     */
     themeConfig?: DefaultTheme.Config;
+    /**
+     * 透传给 VitePress 的 Vite 配置。
+     */
     vite?: UserConfig['vite'];
+    /**
+     * Markdown 能力配置。
+     */
     markdown: WotMarkdownSourceOptions;
+    /**
+     * 额外特性配置。
+     */
     features?: WotVitePressFeatureOptions;
 }
+/**
+ * 主题内部使用的归一化配置。
+ */
 export interface WotResolvedThemeOptions {
+    /**
+     * 埋点配置。
+     */
     analytics: {
+        /**
+         * 是否在路由切换后上报百度统计。
+         */
         trackBaiduRoute: boolean;
     };
+    /**
+     * 归一化后的横幅配置。
+     */
     banner: false | WotThemeBannerOptions;
+    /**
+     * 归一化后的赞助位配置。
+     */
     sponsors: false | WotThemeSponsorOptions;
+    /**
+     * 归一化后的广告位配置。
+     */
     ads: false | WotThemeAdsOptions;
+    /**
+     * 归一化后的团队配置。
+     */
     team: false | WotThemeTeamOptions;
+    /**
+     * 归一化后的友情链接配置。
+     */
     friendly: false | WotThemeFriendlyOptions;
+    /**
+     * 归一化后的案例配置。
+     */
     cases: false | WotThemeCasesOptions;
+    /**
+     * 归一化后的 Demo iframe 配置。
+     */
     demoIframe: false | WotThemeDemoIframeOptions;
+    /**
+     * 归一化后的特别赞助位配置。
+     */
+    specialSponsor: false | WotThemeSponsorOptions;
 }
+/**
+ * 过滤空值后的有效 Vite 插件类型。
+ */
 export type WotVitePlugin = Exclude<PluginOption, null | false | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wot-ui/vitepress-theme",
-  "version": "2.0.0-alpha.15",
+  "version": "2.0.0-alpha.16",
   "type": "module",
   "files": [
     "dist"