diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts index ab44fdc06..fbd927e4b 100644 --- a/docs/.vuepress/theme.ts +++ b/docs/.vuepress/theme.ts @@ -2,100 +2,120 @@ import { hopeTheme } from "vuepress-theme-hope"; import navbar from "./navbar.js"; import sidebar from "./sidebar.js"; -export default hopeTheme({ - // 主题选项：https://theme-hope.vuejs.press/zh/config/theme/layout.html - hostname: "https://newzone.top", - // 公用 CDN 在部分浏览器中可能无法正确显示图标。2024.07 开始，uBlock Origin 将拦截公有 CDN 的 js 请求。 - // https://icon-sets.iconify.design/ - iconAssets: "iconify", - author: { - name: "LearnData", - url: "https://newzone.top", - }, +export default hopeTheme( + { + // 主题选项：https://theme-hope.vuejs.press/zh/config/theme/layout.html + hostname: "https://newzone.top", + // 公用 CDN 在部分浏览器中可能无法正确显示图标。2024.07 开始，uBlock Origin 将拦截公有 CDN 的 js 请求。 + // https://icon-sets.iconify.design/ + iconAssets: "iconify", + author: { + name: "LearnData", + url: "https://newzone.top", + }, - favicon: "/favicon.ico", - logo: "/logo.svg", + favicon: "/favicon.ico", + logo: "/logo.svg", - // 网站文章的版权声明 - license: "CC BY-NC-ND 4.0", + // 网站文章的版权声明 + license: "CC BY-NC-ND 4.0", - // copyright 默认为 Copyright © <作者> - copyright: ` + // copyright 默认为 Copyright © <作者> + copyright: ` 版权声明：自由转载 - 非商用 - 非衍生 - 保持署名（创意共享 4.0 许可证）| Copyright © 2023-present LearnData `, - displayFooter: true, - // 页脚，支持使用 HTMLString 以显示备案信息等 - // footer: `CC BY-NC-ND 4.0 Licensed`, - - // 是否全局启用路径导航 - breadcrumb: false, - - // 页面元数据：贡献者，最后修改时间，编辑链接 - contributors: false, - lastUpdated: true, - editLink: false, - - // 深色模式配置 - darkmode: "switch", - // 全屏按钮 - fullscreen: true, - - // 默认为 GitHub. 同时也可以是一个完整的 URL - repo: "rockbenben/LearnData", - // 自定义仓库链接文字。默认从 `repo` 中自动推断为 "GitHub" / "GitLab" / "Gitee" / "Bitbucket" 其中之一，或是 "Source"。 - repoLabel: "GitHub", - // 是否在导航栏内显示仓库链接，默认为 `true` - repoDisplay: true, - // 文档存放路径 - docsDir: "docs", - - // navbar - navbar: navbar, - // 导航栏布局 - navbarLayout: { - start: ["Brand"], - center: ["Links"], - end: ["SocialLink", "Repo", "Outlook", "Search"], - }, - // 是否在向下滚动时自动隐藏导航栏 - // navbarAutoHide: "always", - - // sidebar - sidebar: sidebar, - // 侧边栏排序规则 - // sidebarSorter: ['readme', 'order', 'title'], - - // 页面布局 Frontmatter 配置：https://theme-hope.vuejs.press/zh/config/frontmatter/layout.html#pageinfo - pageInfo: ["Category", "Tag", "Word", "ReadingTime", "PageView"], - - // 主题功能选项：https://theme-hope.vuejs.press/zh/config/theme/feature.html - blog: { - articleInfo: ["Date", "PageView", "Category", "Tag", "ReadingTime"], - name: "清顺", - avatar: "/avatar_self.webp", - description: "迷信新工具，热衷于研究开源软件、心理学理论，定期分享探索成果", - intro: "/intro.html", - medias: { - GitHub: "https://github.com/rockbenben", - Zhihu: "https://www.zhihu.com/people/qingwhat", - 少数派: { icon: "https://newzone.top/icons/sspai.svg", link: "https://sspai.com/u/zqj05i4v/posts" }, - Wechat: "https://img.newzone.top/wechat.svg", - Email: "mailto:learndata@newzone.top", - Discord: "https://discord.gg/PZTQfJ4GjX", - RSS: "/rss.xml", + displayFooter: true, + // 页脚，支持使用 HTMLString 以显示备案信息等 + // footer: `CC BY-NC-ND 4.0 Licensed`, + + // 是否全局启用路径导航 + breadcrumb: false, + + // 页面元数据：贡献者，最后修改时间，编辑链接 + contributors: false, + lastUpdated: true, + editLink: false, + + // 深色模式配置 + darkmode: "switch", + // 全屏按钮 + fullscreen: true, + + // 默认为 GitHub. 同时也可以是一个完整的 URL + repo: "rockbenben/LearnData", + // 自定义仓库链接文字。默认从 `repo` 中自动推断为 "GitHub" / "GitLab" / "Gitee" / "Bitbucket" 其中之一，或是 "Source"。 + repoLabel: "GitHub", + // 是否在导航栏内显示仓库链接，默认为 `true` + repoDisplay: true, + // 文档存放路径 + docsDir: "docs", + + // navbar + navbar: navbar, + // 导航栏布局 + navbarLayout: { + start: ["Brand"], + center: ["Links"], + end: ["SocialLink", "Repo", "Outlook", "Search"], }, - }, + // 是否在向下滚动时自动隐藏导航栏 + // navbarAutoHide: "always", + + // sidebar + sidebar: sidebar, + // 侧边栏排序规则 + // sidebarSorter: ['readme', 'order', 'title'], + + // 页面布局 Frontmatter 配置：https://theme-hope.vuejs.press/zh/config/frontmatter/layout.html#pageinfo + pageInfo: ["Category", "Tag", "Word", "ReadingTime", "PageView"], + + // 主题功能选项：https://theme-hope.vuejs.press/zh/config/theme/feature.html + blog: { + articleInfo: ["Date", "PageView", "Category", "Tag", "ReadingTime"], + name: "清顺", + avatar: "/avatar_self.webp", + description: "迷信新工具，热衷于研究开源软件、心理学理论，定期分享探索成果", + intro: "/intro.html", + medias: { + GitHub: "https://github.com/rockbenben", + Zhihu: "https://www.zhihu.com/people/qingwhat", + 少数派: { icon: "https://newzone.top/icons/sspai.svg", link: "https://sspai.com/u/zqj05i4v/posts" }, + Wechat: "https://img.newzone.top/wechat.svg", + Email: "mailto:learndata@newzone.top", + Discord: "https://discord.gg/PZTQfJ4GjX", + RSS: "/rss.xml", + }, + }, + + // 隐藏打印按钮 + // print: false, - // 隐藏打印按钮 - // print: false, + markdown: { + align: true, // 启用自定义对齐 + attrs: true, // 使用特殊标记为 Markdown 元素添加属性 + mark: true, // 使用 == == 进行标记，注意两边需要有空格 + // spoiler: true, // 使用 !! !! 标记剧透剧透文字，注意两边需要有空格 + sup: true, // 上下角标 + sub: true, + include: true, // 导入文件 + footnote: true, // 页脚格式支持 + tasklist: true, // 启用任务列表格式支持，您可以传递一个对象来配置任务列表 + component: true, // 使用 component 代码块来在 Markdown 中添加组件，YAML 和 JSON 的数据格式均受支持 + figure: true, // 启用 figure + imgLazyload: true, // 启用图片懒加载 + // imgMark: true, // 启用图片标记 + imgSize: true, // 启用图片大小 + hint: true, // 启用提示容器，默认启用 + alert: true, // 启用 GFM 警告 + }, - plugins: { - blog: true, + plugins: { + blog: true, - // 评论配置（仅做样例，记得更换） - comment: { - /* + // 评论配置（仅做样例，记得更换） + comment: { + /* // 在本地运行 `pnpm docs:dev` 并使用非 localhost 域名时，容易出现 403 错误，移除本部分即可解决 provider: "Waline", serverURL: "https://waline.newzone.top", @@ -129,69 +149,45 @@ export default hopeTheme({ }, */ - // Giscus - provider: "Giscus", - repo: "rockbenben/giscus-comment", - repoId: "R_kgDOM_MPJA", - category: "Comments", - categoryId: "DIC_kwDOM_MPJM4CjS0P", - }, + // Giscus + provider: "Giscus", + repo: "rockbenben/giscus-comment", + repoId: "R_kgDOM_MPJA", + category: "Comments", + categoryId: "DIC_kwDOM_MPJM4CjS0P", + }, - // 组件库 - components: { - components: ["Badge", "BiliBili", "VidStack"], - }, + // 组件库 + components: { + components: ["Badge", "BiliBili", "VidStack"], + }, - // 禁用不需要的配置 - // https://plugin-md-enhance.vuejs.press/zh/guide/ - mdEnhance: { - sub: true, // 上下角标 - sup: true, - tasklist: true, // 任务列表 - include: true, //导入文件 - component: true, // 使用 component 代码块来在 Markdown 中添加组件 - footnote: true, - // tabs: true, // 选项卡 - attrs: true, // 使用特殊标记为 Markdown 元素添加属性 - mark: true, // 使用 == == 进行标记。请注意两边需要有空格。 - align: true, // 启用自定义对齐 - // codetabs: true, // 代码块分组 - // demo: true, //代码演示 - }, - markdownImage: { - // mark: true, // 启用图片标记 - lazyload: true, // 启用图片懒加载 - size: true, // 启用图片大小 - figure: true, // 启用图片 figure - }, - markdownHint: { - alert: true, // GFM 警告 - hint: true, // 提示容器 - }, - // Algolia 全文搜索：需要自己设置爬虫并生成下方配置，如不会自己设置，启用下方本地搜索 - /* - docsearch: { - indexName: "newzone", - appId: "M4EXXEZIEG", - apiKey: "fd8891a9c4cc21e0ef4f11bf44f7a11e", - }, - */ + // Algolia 全文搜索：需要自己设置爬虫并生成下方配置，如不会自己设置，启用下方本地搜索 + /* + docsearch: { + indexName: "", + appId: "", + apiKey: "", + }, + */ - // 本地搜索，和上方二选一 - searchPro: { - // 索引全部内容 - indexContent: true, - }, + // 本地搜索，和上方二选一 + slimsearch: { + // 索引全部内容 + indexContent: true, + }, - feed: { - atom: true, - json: true, - rss: true, - count: 10, - sorter: (a, b) => Number(b.frontmatter.date) - Number(a.frontmatter.date), + feed: { + atom: true, + json: true, + rss: true, + count: 10, + sorter: (a, b) => Number(b.frontmatter.date) - Number(a.frontmatter.date), + }, }, - }, - // 开发模式下是否启动热更新，显示所有更改并重新渲染 - hotReload: true, -}); + // 开发模式下是否启动热更新，显示所有更改并重新渲染 + hotReload: true, + }, + { custom: true } +);