From c3b826c7b6df800c2a7e2d58c439c5a42a7c445f Mon Sep 17 00:00:00 2001
From: BeiyanYunyi <14120445+BeiyanYunyi@users.noreply.github.com>
Date: Wed, 25 Sep 2024 22:37:58 +0800
Subject: [PATCH] feat(theme): :sparkles: enable and disable changelog and
 suggestion box

---
 example/docs/.vitepress/config.ts |  2 ++
 src/Layout.vue                    |  2 +-
 src/components/AppFooter.vue      | 28 ++++++++++++++++++++--------
 src/config.ts                     | 27 ++++++++++++++++++++++-----
 src/utils/themeContext.ts         |  2 ++
 5 files changed, 47 insertions(+), 14 deletions(-)

diff --git a/example/docs/.vitepress/config.ts b/example/docs/.vitepress/config.ts
index cec6d91..548ecd6 100644
--- a/example/docs/.vitepress/config.ts
+++ b/example/docs/.vitepress/config.ts
@@ -19,6 +19,8 @@ const themeConfig: ThemeContext = {
   include: ['campus', 'contributor-guide', 'fashion'],
   nav,
   sidebarOptions,
+  enableChangeLog: false,
+  enableSuggestionBox: false,
 }
 
 // https://vitepress.dev/reference/site-config
diff --git a/src/Layout.vue b/src/Layout.vue
index 9a9815d..1bf8e6d 100644
--- a/src/Layout.vue
+++ b/src/Layout.vue
@@ -47,4 +47,4 @@ const { frontmatter } = useData()
   --vp-font-family-base: sans-serif;
   --vp-font-family-mono: monospace;
 }
-</style>
\ No newline at end of file
+</style>
diff --git a/src/components/AppFooter.vue b/src/components/AppFooter.vue
index e09fa7d..f874602 100644
--- a/src/components/AppFooter.vue
+++ b/src/components/AppFooter.vue
@@ -1,10 +1,12 @@
 <script setup lang="ts">
 import { NolebaseGitChangelog } from '@nolebase/vitepress-plugin-git-changelog/client'
-import { useRoute } from 'vitepress'
+import { useData, useRoute } from 'vitepress'
 import { ref, watch } from 'vue'
 import { AppSBox } from '../components'
+import type { PjtsThemeConfig } from '../config'
 
 const route = useRoute()
+const { theme } = useData<PjtsThemeConfig>()
 
 // 定义一个 ref 来存储动态 key
 const componentKey = ref(0)
@@ -19,10 +21,14 @@ function updateKeyAndFrontmatter() {
 }
 
 // 监听路由变化，更新 key 和 frontmatter
-watch(() => route.path, () => {
-  isFrontmatterLoaded.value = false
-  updateKeyAndFrontmatter()
-}, { immediate: true }) // 在组件挂载时立即执行一次，确保第一次渲染时 key 和 frontmatter 是正确的
+watch(
+  () => route.path,
+  () => {
+    isFrontmatterLoaded.value = false
+    updateKeyAndFrontmatter()
+  },
+  { immediate: true },
+) // 在组件挂载时立即执行一次，确保第一次渲染时 key 和 frontmatter 是正确的
 
 // 在组件挂载时更新 key 和 frontmatter
 // onMounted(updateKeyAndFrontmatter);
@@ -30,11 +36,17 @@ watch(() => route.path, () => {
 
 <template>
   <div :key="componentKey" class="vp-doc">
-    <h2 id="意见反馈">
+    <h2 v-if="theme.enableSuggestionBox" id="意见反馈">
       意见反馈
     </h2>
-    <AppSBox />
+    <AppSBox v-if="theme.enableSuggestionBox" />
     <!-- 仅在 Frontmatter 加载完成且未设置 hideChangelog 时渲染 GitChangelog -->
-    <NolebaseGitChangelog v-if="isFrontmatterLoaded && !frontmatter.hideChangelog" />
+    <NolebaseGitChangelog
+      v-if="
+        isFrontmatterLoaded
+          && theme.enableChangeLog
+          && !frontmatter.hideChangelog
+      "
+    />
   </div>
 </template>
diff --git a/src/config.ts b/src/config.ts
index 28f5470..3421aec 100644
--- a/src/config.ts
+++ b/src/config.ts
@@ -10,11 +10,17 @@ import katex from 'markdown-it-katex'
 import mdPangu from 'markdown-it-pangu'
 import UnoCSS from 'unocss/vite'
 import Components from 'unplugin-vue-components/vite'
-import { defineConfig } from 'vitepress'
+import type { DefaultTheme } from 'vitepress'
+import { defineConfigWithTheme } from 'vitepress'
 
 import { generateSidebar } from './sidebar'
 import { useThemeContext } from './utils/themeContext'
 
+export interface PjtsThemeConfig extends DefaultTheme.Config {
+  enableChangeLog?: boolean
+  enableSuggestionBox?: boolean
+}
+
 // 从文件系统读取 Markdown 文件内容
 function readMarkdownFileContent(filePath: string): string {
   if (fs.existsSync(filePath)) {
@@ -34,7 +40,8 @@ function countWords(content: string): number {
     .replace(/\s+/g, ' ') // 将多余的空格归为一个空格
     .trim() // 去除首尾空格
 
-  const chineseCharacters = cleanedContent.match(/[\u4E00-\u9FFF\uFF01-\uFFE5]/g) || []
+  const chineseCharacters
+    = cleanedContent.match(/[\u4E00-\u9FFF\uFF01-\uFFE5]/g) || []
   const words = cleanedContent.split(/\s+/).filter(Boolean)
 
   return chineseCharacters.length + words.length
@@ -43,9 +50,16 @@ function countWords(content: string): number {
 // https://vitepress.dev/reference/site-config
 function genConfig() {
   const themeConfig = useThemeContext()
-  const { siteTitle, githubRepoLink, nav, siteLogo, SiteTitle}
-    = themeConfig
-  return defineConfig({
+  const {
+    siteTitle,
+    githubRepoLink,
+    nav,
+    siteLogo,
+    SiteTitle,
+    enableChangeLog = true,
+    enableSuggestionBox = true,
+  } = themeConfig
+  return defineConfigWithTheme<PjtsThemeConfig>({
     lang: 'zh-CN',
     title: siteTitle,
     cleanUrls: true,
@@ -89,6 +103,8 @@ function genConfig() {
       ['meta', { property: 'og:site_name', content: siteTitle }],
     ],
     themeConfig: {
+      enableSuggestionBox,
+      enableChangeLog,
       // https://vitepress.dev/reference/default-theme-config
       siteTitle: SiteTitle,
       logo: siteLogo,
@@ -163,6 +179,7 @@ function genConfig() {
       plugins: [
         GitChangelog({
           repoURL: githubRepoLink,
+          include: enableChangeLog ? ['** /*.md', '!node_modules'] : [],
         }),
         // GitChangelogMarkdownSection({
         //   sections: {
diff --git a/src/utils/themeContext.ts b/src/utils/themeContext.ts
index 4932949..8b92c2b 100644
--- a/src/utils/themeContext.ts
+++ b/src/utils/themeContext.ts
@@ -15,6 +15,8 @@ export interface ThemeContext {
   include: string[]
   nav: NavConfig
   sidebarOptions: Options | Options[]
+  enableSuggestionBox?: boolean
+  enableChangeLog?: boolean
 }
 
 const themeContext = new AsyncLocalStorage<ThemeContext>()