@tnotesjs/core 0.1.0

package/vitepress/components/Tooltip/Tooltip.vue

@@ -0,0 +1,70 @@
+<template>
+  <span
+    class="tooltip-wrapper"
+    @mouseenter="showTooltip = true"
+    @mouseleave="showTooltip = false"
+  >
+    <slot></slot>
+    <span v-if="showTooltip" class="tooltip">{{ text }}</span>
+  </span>
+</template>
+
+<script setup lang="ts">
+import { ref } from 'vue'
+
+defineProps({
+  text: {
+    type: String,
+    required: true,
+  },
+})
+
+const showTooltip = ref(false)
+</script>
+
+<style scoped>
+.tooltip-wrapper {
+  position: relative;
+  display: inline-block;
+}
+
+.tooltip {
+  position: absolute;
+  bottom: 100%;
+  left: 50%;
+  transform: translateX(-50%) translateY(-8px);
+  background-color: var(--vp-c-bg-elv);
+  color: var(--vp-c-text-1);
+  padding: 6px 12px;
+  border-radius: 6px;
+  font-size: 14px;
+  font-weight: 500;
+  white-space: nowrap;
+  box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
+  border: 1px solid var(--vp-c-divider);
+  z-index: 100;
+  animation: tooltipFadeIn 0.15s ease-out;
+  pointer-events: none;
+}
+
+.tooltip::after {
+  content: '';
+  position: absolute;
+  top: 100%;
+  left: 50%;
+  transform: translateX(-50%);
+  border: 6px solid transparent;
+  border-top-color: var(--vp-c-bg-elv);
+}
+
+@keyframes tooltipFadeIn {
+  from {
+    opacity: 0;
+    transform: translateX(-50%) translateY(-4px);
+  }
+  to {
+    opacity: 1;
+    transform: translateX(-50%) translateY(-8px);
+  }
+}
+</style>

package/vitepress/components/constants.ts

@@ -0,0 +1,91 @@
+/**
+ * 以下常量由 defineNotesConfig() 通过 vite.define 注入
+ * 见 vitepress/config/index.ts 中的 define 配置
+ */
+declare const __TNOTES_REPO_NAME__: string
+declare const __TNOTES_AUTHOR__: string
+declare const __TNOTES_IGNORE_DIRS__: string[]
+declare const __TNOTES_ROOT_ITEM__: any
+
+/**
+ * 笔记仓库名儿
+ */
+export const REPO_NAME: string = __TNOTES_REPO_NAME__
+
+/**
+ * 笔记仓库作者
+ */
+export const AUTHOR: string = __TNOTES_AUTHOR__
+
+/**
+ * notes 目录下需要忽略的笔记目录
+ * @example
+ * [".vscode", "0000", "assets", "node_modules"]
+ */
+export const IGNORE_DIRS: string[] = __TNOTES_IGNORE_DIRS__
+
+/**
+ * 根知识库配置项
+ */
+export const ROOT_ITEM = __TNOTES_ROOT_ITEM__
+
+/**
+ * 存储本地笔记文件夹所在位置的 key
+ */
+export const NOTES_DIR_KEY: string = 'NOTES_DIR_KEY__' + REPO_NAME
+
+/**
+ * 用户选择的视图
+ */
+export const NOTES_VIEW_KEY: string = 'NOTES_VIEW_KEY__' + REPO_NAME
+
+/**
+ * 全局配置 EnWordList.vue 组件是否自动展示词汇卡片
+ */
+export const EN_WORD_LIST_COMP_IS_AUTO_SHOW_CARD: string =
+  'EN_WORD_LIST_COMP_IS_AUTO_SHOW_CARD__' + REPO_NAME
+
+/**
+ * MarkMap 默认主题配置
+ */
+export const MARKMAP_THEME_KEY: string = 'MARKMAP_THEME_KEY__' + REPO_NAME
+
+/**
+ * MarkMap 默认展开层级配置
+ */
+export const MARKMAP_EXPAND_LEVEL_KEY: string =
+  'MARKMAP_EXPAND_LEVEL_KEY__' + REPO_NAME
+
+/**
+ * 侧边栏是否显示笔记编号配置
+ */
+export const SIDEBAR_SHOW_NOTE_ID_KEY: string =
+  'SIDEBAR_SHOW_NOTE_ID_KEY__' + REPO_NAME
+
+/**
+ * 侧边栏最大解析层级配置
+ * 默认值为 3，表示支持 3 层嵌套（组 → 子组 → 笔记）
+ */
+export const SIDEBAR_MAX_DEPTH_KEY: string =
+  'SIDEBAR_MAX_DEPTH_KEY__' + REPO_NAME
+
+/**
+ * VitePress HOME README 文件名
+ * 该文件内容基于 HOME README 而生成，作为 github pages 中的 README 文件，主要用于展示笔记的目录结构。
+ */
+export const TOC: string = 'TOC'
+export const TOC_MD: string = TOC + '.md'
+
+/**
+ * 英语单词仓库基地址
+ * https://github.com/tnotesjs/en-words/blob/main/{word}.md
+ */
+export const EN_WORDS_REPO_BASE_URL: string =
+  'https://github.com/tnotesjs/TNotes.en-words/blob/main/'
+
+/**
+ * 英语单词仓库 raw 地址
+ * https://raw.githubusercontent.com/tnotesjs/TNotes.en-words/refs/heads/main/{word}.md
+ */
+export const EN_WORDS_REPO_BASE_RAW_URL: string =
+  'https://raw.githubusercontent.com/tnotesjs/TNotes.en-words/refs/heads/main/'

package/vitepress/components/notesConfig.data.ts

@@ -0,0 +1,73 @@
+// .vitepress/components/notesConfig.data.ts
+import fs from 'node:fs'
+import path from 'node:path'
+
+const rootPath = process.cwd()
+
+/**
+ * 从配置文件读取忽略目录列表
+ * 注意：data loader 运行在 Node.js 上下文，不经过 vite.define，
+ * 因此需要直接读取配置文件而非从 constants.ts 导入。
+ */
+function getIgnoreDirs(): string[] {
+  try {
+    const configPath = path.resolve(process.cwd(), '.tnotes.json')
+    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'))
+    return config.ignore_dirs || []
+  } catch {
+    return []
+  }
+}
+
+interface NoteConfig {
+  [key: string]: any
+  redirect?: string
+}
+
+export default {
+  // 监听笔记目录下第一级的 .tnotes.json 文件变化
+  watch: [
+    path.resolve(rootPath, 'notes').replace(/\\/g, '/') + '/*/.tnotes.json',
+  ],
+  load(watchedFiles: string[]): Record<string, NoteConfig> {
+    // console.log('watchedFiles', watchedFiles)
+
+    const IGNORE_DIRS = getIgnoreDirs()
+
+    // 初始化一个空对象，用于存储所有笔记的配置数据（以笔记索引为键）
+    const allNotesConfig: Record<string, NoteConfig> = {}
+
+    // 遍历所有监听到的 .tnotes.json 文件
+    watchedFiles.forEach((filePath) => {
+      try {
+        // 检查目录是否在忽略列表中
+        const dirName = filePath.split('/').slice(-2, -1)[0] // 提取目录名称
+        if (IGNORE_DIRS.includes(dirName)) {
+          console.log(`Skipping ignored directory: ${dirName}`)
+          return // 跳过忽略的目录
+        }
+
+        // 读取文件内容
+        const fileContent = fs.readFileSync(filePath, 'utf-8')
+        const configData = JSON.parse(fileContent) as NoteConfig
+
+        // 提取笔记索引（文件路径中前 4 个数字）
+        const noteIndexMatch = filePath.match(/notes\/(\d{4})\./)
+        if (noteIndexMatch) {
+          const noteIndex = noteIndexMatch[1] // 获取笔记索引
+          const redirect = filePath.replace(/\.tnotes\.json$/, 'README')
+          allNotesConfig[noteIndex] = {
+            ...configData,
+            redirect,
+          } // 将配置数据存入对象
+        }
+      } catch (error) {
+        console.error(`Failed to load config file: ${filePath}`, error)
+      }
+    })
+
+    // console.log('All notes config loaded:', allNotesConfig)
+
+    return allNotesConfig
+  },
+}

package/vitepress/components/sidebar.data.ts

@@ -0,0 +1,59 @@
+/**
+ * .vitepress/tnotes/vitepress/components/sidebar.data.ts
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+const rootPath = process.cwd()
+
+/**
+ * VitePress Data Loader for Sidebar
+ * 通过监听 sidebar.json 文件变化，使用 HMR 热更新
+ */
+
+interface SidebarItem {
+  text: string
+  link: string
+}
+
+interface SidebarGroup {
+  text: string
+  collapsed?: boolean
+  items: SidebarItem[]
+}
+
+interface SidebarConfig {
+  '/notes/': SidebarGroup[]
+}
+
+export default {
+  // 监听 sidebar.json 文件变化
+  watch: [path.resolve(rootPath, 'sidebar.json')],
+
+  load(watchedFiles: string[]): SidebarConfig {
+    const sidebarFilePath = watchedFiles[0]
+
+    try {
+      // 读取 sidebar.json 文件
+      const fileContent = fs.readFileSync(sidebarFilePath, 'utf-8')
+      const sidebarArray = JSON.parse(fileContent) as SidebarGroup[]
+
+      // 期望的格式是 { '/notes/': [...] }
+      const sidebarData: SidebarConfig = {
+        '/notes/': sidebarArray,
+      }
+
+      console.log('[sidebar.data.ts] Sidebar loaded,')
+
+      return sidebarData
+    } catch (error) {
+      console.error('❌ [sidebar.data.ts] Failed to load sidebar.json:', error)
+
+      // 返回空的 sidebar 配置作为后备
+      return {
+        '/notes/': [],
+      }
+    }
+  },
+}

package/vitepress/components/tnotes-config.data.ts

@@ -0,0 +1,21 @@
+import fs from 'node:fs'
+import path from 'node:path'
+
+const rootPath = process.cwd()
+
+export interface TNotesConfig {
+  sidebarShowNoteId: boolean
+  author?: string
+  repoName?: string
+  [key: string]: any
+}
+
+export default {
+  watch: [path.resolve(rootPath, '.tnotes.json')],
+  load(watchedFiles: string[]): TNotesConfig {
+    console.log('[tnotes-config.data.ts] Config loaded')
+    const fileContent = fs.readFileSync(watchedFiles[0], 'utf-8')
+    const config = JSON.parse(fileContent) as TNotesConfig
+    return config
+  },
+}

package/vitepress/components/utils.ts

@@ -0,0 +1,26 @@
+export const formatDate = (timestamp: number): string => {
+  const date = new Date(timestamp)
+  const year = date.getFullYear()
+  const month = String(date.getMonth() + 1).padStart(2, '0')
+  const day = String(date.getDate()).padStart(2, '0')
+  const weekDays = ['日', '一', '二', '三', '四', '五', '六']
+  const weekDay = weekDays[date.getDay()]
+  const hours = String(date.getHours()).padStart(2, '0')
+  const minutes = String(date.getMinutes()).padStart(2, '0')
+  const seconds = String(date.getSeconds()).padStart(2, '0')
+
+  const footprintsDay = getFootprintsDay(timestamp)
+  // const period = hours < 12 ? '上午' : '下午'
+  // const formattedHours = hours % 12 || 12
+
+  return `👣 ${footprintsDay} | ${year}年${month}月${day}日 周${weekDay} ${hours}:${minutes}:${seconds}`
+  // return `${year}-${month}-${day} 周${weekDay} ${period} ${formattedHours}:${minutes}:${seconds}`
+}
+
+export const getFootprintsDay = (timestamp: number = Date.now()): number =>
+  Math.floor(
+    (timestamp - new Date(1999, 5, 29).getTime()) / (1000 * 60 * 60 * 24)
+  ) + 1
+
+export const scrollToTop = (): void =>
+  window.scrollTo({ top: 0, behavior: 'smooth' })

package/vitepress/config/index.ts

@@ -0,0 +1,126 @@
+/**
+ * .vitepress/tnotes/vitepress/config/index.ts
+ *
+ * VitePress 站点配置工厂函数
+ *
+ * 将所有共享配置封装在 tnotesjs/core 中，外围 config.mts 只需一行调用：
+ *   import { defineNotesConfig } from './tnotes/vitepress/config'
+ *   export default defineNotesConfig()
+ */
+import fs from 'fs'
+import path from 'path'
+import { defineConfig, type UserConfig } from 'vitepress'
+import type { TNotesConfig } from '../../types'
+import {
+  getIgnoreList,
+  getGithubPageUrl,
+  getHeadConfig,
+  getMarkdownConfig,
+  getThemeConfig,
+} from '../configs'
+import { updateConfigPlugin } from '../plugins/updateConfigPlugin'
+import { renameNotePlugin } from '../plugins/renameNotePlugin'
+import { getNoteByConfigIdPlugin } from '../plugins/getNoteByConfigIdPlugin'
+import { buildProgressPlugin } from '../plugins/buildProgressPlugin'
+
+/**
+ * 读取 .tnotes.json 配置文件
+ */
+function loadTNotesConfig(rootPath: string): TNotesConfig {
+  const configPath = path.resolve(rootPath, '.tnotes.json')
+  const configContent = fs.readFileSync(configPath, 'utf-8')
+  return JSON.parse(configContent) as TNotesConfig
+}
+
+/**
+ * 创建 VitePress 站点配置
+ *
+ * @param overrides - 可选的覆盖配置，会与默认配置合并
+ * @returns VitePress 配置对象
+ */
+export function defineNotesConfig(overrides: UserConfig = {}) {
+  const rootPath = process.cwd()
+  const config = loadTNotesConfig(rootPath)
+  const { repoName } = config
+
+  const IGNORE_LIST = getIgnoreList(config)
+  const GITHUB_PAGE_URL = getGithubPageUrl(config)
+
+  const {
+    transformPageData: overrideTransformPageData,
+    vite: overrideVite,
+    ...restOverrides
+  } = overrides
+
+  return defineConfig({
+    appearance: 'dark',
+    base: '/' + repoName + '/',
+    cleanUrls: true,
+    description: repoName,
+    head: getHeadConfig(config, GITHUB_PAGE_URL),
+    ignoreDeadLinks: true,
+    lang: 'zh-Hans',
+    lastUpdated: false,
+    markdown: getMarkdownConfig(),
+    sitemap: {
+      hostname: GITHUB_PAGE_URL,
+      lastmodDateOnly: false,
+    },
+    themeConfig: getThemeConfig(config),
+    title: repoName,
+    srcExclude: IGNORE_LIST,
+    vite: {
+      plugins: [
+        buildProgressPlugin() as any,
+        updateConfigPlugin() as any,
+        renameNotePlugin() as any,
+        getNoteByConfigIdPlugin() as any,
+        ...(overrideVite?.plugins || []),
+      ],
+      server: {
+        watch: {
+          ignored: IGNORE_LIST,
+        },
+        ...overrideVite?.server,
+      },
+      css: {
+        preprocessorOptions: {
+          scss: {
+            silenceDeprecations: ['legacy-js-api'],
+          },
+        },
+        ...overrideVite?.css,
+      },
+      build: {
+        chunkSizeWarningLimit: 1000,
+        ...overrideVite?.build,
+      },
+      define: {
+        __TNOTES_REPO_NAME__: JSON.stringify(config.repoName),
+        __TNOTES_AUTHOR__: JSON.stringify(config.author),
+        __TNOTES_IGNORE_DIRS__: JSON.stringify(config.ignore_dirs),
+        __TNOTES_ROOT_ITEM__: JSON.stringify(config.root_item),
+        ...overrideVite?.define,
+      },
+    },
+    transformPageData(pageData, ctx) {
+      // 为笔记页面注入原始 Markdown 内容（用于一键复制功能）
+      if (/^notes\/\d{4}/.test(pageData.relativePath)) {
+        const fullPath = path.resolve(rootPath, pageData.relativePath)
+        try {
+          pageData.frontmatter.rawContent = fs.readFileSync(fullPath, 'utf-8')
+        } catch {
+          pageData.frontmatter.rawContent = null
+        }
+      }
+      // 执行外部覆盖的 transformPageData（如有）
+      if (typeof overrideTransformPageData === 'function') {
+        return overrideTransformPageData(pageData, ctx)
+      }
+    },
+    router: {
+      prefetchLinks: false,
+    },
+    ...restOverrides,
+  })
+}

package/vitepress/configs/constants.ts

@@ -0,0 +1,26 @@
+/**
+ * .vitepress/config/constants.ts
+ *
+ * 常量配置 - 从运行时配置派生，不再硬编码相对路径 import
+ */
+import type { TNotesConfig } from '../../types'
+
+/**
+ * 获取忽略的文件和目录列表
+ */
+export function getIgnoreList(config: TNotesConfig): string[] {
+  return [...config.ignore_dirs.map((dir: string) => `**/${dir}/**`)]
+}
+
+/**
+ * 获取 GitHub Pages URL
+ */
+export function getGithubPageUrl(config: TNotesConfig): string {
+  return (
+    'https://' +
+    config.author.toLowerCase() +
+    '.github.io/' +
+    config.repoName +
+    '/'
+  )
+}

package/vitepress/configs/head.config.ts

@@ -0,0 +1,25 @@
+/**
+ * .vitepress/config/head.config.ts
+ *
+ * HTML head 标签配置
+ */
+import { HeadConfig } from 'vitepress'
+import type { TNotesConfig } from '../../types'
+
+export function getHeadConfig(config: TNotesConfig, githubPageUrl: string): HeadConfig[] {
+  const head: HeadConfig[] = [
+    [
+      'meta',
+      {
+        name: 'keywords',
+        content: config.keywords.join(', '),
+      },
+    ],
+    ['meta', { name: 'author', content: config.author }],
+    ['link', { rel: 'canonical', href: githubPageUrl }],
+    ['link', { rel: 'icon', href: githubPageUrl + 'favicon.ico' }],
+    ['link', { rel: 'preconnect', href: 'https://fonts.googleapis.com' }],
+  ]
+
+  return head
+}

package/vitepress/configs/index.ts

@@ -0,0 +1,9 @@
+/**
+ * .vitepress/config/_index.ts
+ *
+ * 配置模块统一导出
+ */
+export { getIgnoreList, getGithubPageUrl } from './constants'
+export { getHeadConfig } from './head.config'
+export { getMarkdownConfig } from './markdown.config'
+export { getThemeConfig } from './theme.config'

package/vitepress/configs/markdown-it.d.ts

@@ -0,0 +1,23 @@
+/**
+ * .vitepress/config/markdown-it.d.ts
+ *
+ * 第三方库类型声明
+ */
+
+declare module 'markdown-it-container' {
+  import { PluginWithOptions } from 'markdown-it'
+  const markdownItContainer: PluginWithOptions<any>
+  export default markdownItContainer
+}
+
+declare module 'markdown-it-link-attributes' {
+  import { PluginWithOptions } from 'markdown-it'
+  const markdownItLinkAttributes: PluginWithOptions<any>
+  export default markdownItLinkAttributes
+}
+
+declare module 'markdown-it-task-lists' {
+  import { PluginWithOptions } from 'markdown-it'
+  const markdownItTaskLists: PluginWithOptions<any>
+  export default markdownItTaskLists
+}