@tnotesjs/core 0.1.22 → 0.1.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/README.md +87 -87
  2. package/package.json +1 -1
  3. package/types/config.ts +60 -60
  4. package/types/index.ts +11 -11
  5. package/types/note.ts +33 -33
  6. package/vitepress/assets/icons/icon__check.svg +3 -3
  7. package/vitepress/assets/icons/icon__clipboard.svg +7 -7
  8. package/vitepress/assets/icons/icon__close.svg +1 -1
  9. package/vitepress/assets/icons/icon__collapse.svg +1 -1
  10. package/vitepress/assets/icons/icon__confirm.svg +1 -1
  11. package/vitepress/assets/icons/icon__copy.svg +4 -4
  12. package/vitepress/assets/icons/icon__focus.svg +1 -1
  13. package/vitepress/assets/icons/icon__fold.svg +3 -3
  14. package/vitepress/assets/icons/icon__folder.svg +1 -1
  15. package/vitepress/assets/icons/icon__fullscreen.svg +1 -1
  16. package/vitepress/assets/icons/icon__fullscreen_exit.svg +1 -1
  17. package/vitepress/assets/icons/icon__github.svg +3 -3
  18. package/vitepress/assets/icons/icon__mindmap.svg +1 -1
  19. package/vitepress/assets/icons/icon__next.svg +1 -1
  20. package/vitepress/assets/icons/icon__number_gray.svg +1 -1
  21. package/vitepress/assets/icons/icon__number_purple.svg +1 -1
  22. package/vitepress/assets/icons/icon__prev.svg +1 -1
  23. package/vitepress/assets/icons/icon__restore.svg +1 -1
  24. package/vitepress/assets/icons/icon__rotate.svg +4 -4
  25. package/vitepress/assets/icons/icon__search.svg +1 -1
  26. package/vitepress/assets/icons/icon__sidebar_collapsed.svg +1 -1
  27. package/vitepress/assets/icons/icon__sidebar_opened.svg +1 -1
  28. package/vitepress/assets/icons/icon__totop.svg +5 -5
  29. package/vitepress/assets/icons/icon__vscode.svg +5 -5
  30. package/vitepress/assets/icons/icon__zoom_fit.svg +1 -1
  31. package/vitepress/assets/icons/icon__zoom_in.svg +1 -1
  32. package/vitepress/assets/icons/icon__zoom_out.svg +1 -1
  33. package/vitepress/assets/icons/icon__zoom_reset.svg +1 -1
  34. package/vitepress/assets/icons/index.ts +39 -39
  35. package/vitepress/components/BilibiliOutsidePlayer/BilibiliOutsidePlayer.vue +20 -20
  36. package/vitepress/components/CodeBlockFullscreen/CodeBlockFullscreen.vue +369 -369
  37. package/vitepress/components/CodeBlockFullscreen/index.ts +209 -209
  38. package/vitepress/components/CodeBlockFullscreen/styles.css +126 -126
  39. package/vitepress/components/Discussions/Discussions.vue +242 -242
  40. package/vitepress/components/EnWordList/EnWordList.vue +664 -664
  41. package/vitepress/components/EnWordList/RightClickMenu.vue +87 -87
  42. package/vitepress/components/Footprints/Footprints.vue +472 -472
  43. package/vitepress/components/Layout/AboutModal.vue +329 -329
  44. package/vitepress/components/Layout/AboutPanel.vue +485 -485
  45. package/vitepress/components/Layout/ContentCollapse.vue +591 -591
  46. package/vitepress/components/Layout/CustomSidebar.vue +817 -817
  47. package/vitepress/components/Layout/DocBeforeControls.vue +145 -145
  48. package/vitepress/components/Layout/DocFooter.vue +233 -233
  49. package/vitepress/components/Layout/ImagePreview.vue +485 -485
  50. package/vitepress/components/Layout/Layout.vue +744 -744
  51. package/vitepress/components/Layout/NoteStatus.vue +140 -140
  52. package/vitepress/components/Layout/SidebarItems.vue +1083 -1083
  53. package/vitepress/components/Layout/SidebarNavBefore.vue +170 -170
  54. package/vitepress/components/Layout/SidebarResizeHandle.vue +368 -311
  55. package/vitepress/components/Layout/Swiper.vue +167 -167
  56. package/vitepress/components/Layout/ToggleFullContent.vue +45 -45
  57. package/vitepress/components/Layout/ToggleSidebar.vue +35 -35
  58. package/vitepress/components/Layout/composables/useCollapseControl.ts +88 -88
  59. package/vitepress/components/Layout/composables/useNoteConfig.ts +119 -119
  60. package/vitepress/components/Layout/composables/useNoteSave.ts +178 -178
  61. package/vitepress/components/Layout/composables/useNoteValidation.ts +85 -85
  62. package/vitepress/components/Layout/composables/useRedirect.ts +113 -113
  63. package/vitepress/components/Layout/composables/useSidebarLayout.ts +122 -122
  64. package/vitepress/components/Layout/composables/useVSCodeIntegration.ts +85 -85
  65. package/vitepress/components/Layout/homeReadme.data.ts +124 -124
  66. package/vitepress/components/MarkMap/MarkMap.vue +562 -562
  67. package/vitepress/components/Mermaid/Mermaid.vue +644 -644
  68. package/vitepress/components/NotesTable/NotesTable.vue +175 -175
  69. package/vitepress/components/NotesTable/README.md +67 -67
  70. package/vitepress/components/Settings/Settings.vue +711 -711
  71. package/vitepress/components/SidebarCard/MindMapView.vue +484 -484
  72. package/vitepress/components/SidebarCard/NotesTrendChart.vue +108 -108
  73. package/vitepress/components/SidebarCard/SidebarCard.vue +945 -945
  74. package/vitepress/components/Tooltip/Tooltip.vue +70 -70
  75. package/vitepress/components/constants.ts +109 -109
  76. package/vitepress/components/notesConfig.data.ts +73 -73
  77. package/vitepress/components/sidebar.data.ts +59 -59
  78. package/vitepress/components/tnotes-config.data.ts +21 -21
  79. package/vitepress/components/utils.ts +26 -26
  80. package/vitepress/config/index.ts +169 -169
  81. package/vitepress/configs/constants.ts +26 -26
  82. package/vitepress/configs/head.config.ts +25 -25
  83. package/vitepress/configs/index.ts +9 -9
  84. package/vitepress/configs/markdown-it.d.ts +23 -23
  85. package/vitepress/configs/markdown.config.ts +368 -368
  86. package/vitepress/configs/theme.config.ts +108 -108
  87. package/vitepress/plugins/buildProgressPlugin.ts +434 -434
  88. package/vitepress/plugins/getNoteByConfigIdPlugin.ts +107 -107
  89. package/vitepress/plugins/renameNotePlugin.ts +68 -68
  90. package/vitepress/plugins/sidebarStructurePlugin.ts +260 -260
  91. package/vitepress/plugins/updateConfigPlugin.ts +63 -63
  92. package/vitepress/theme/index.ts +137 -137
  93. package/vitepress/theme/styles/base.scss +66 -64
  94. package/vitepress/theme/styles/components/404.scss +31 -31
  95. package/vitepress/theme/styles/components/collapse.scss +172 -172
  96. package/vitepress/theme/styles/components/markmap.scss +101 -101
  97. package/vitepress/theme/styles/components/swiper.scss +255 -255
  98. package/vitepress/theme/styles/index.scss +25 -25
  99. package/vitepress/theme/styles/layout.scss +79 -78
  100. package/vitepress/theme/styles/utilities.scss +39 -39
  101. package/vitepress/theme/styles/vitepress-override.scss +25 -25
@@ -1,137 +1,137 @@
1
- /**
2
- * .vitepress/tnotes/theme/index.ts
3
- *
4
- * 自定义主题
5
- *
6
- * 提供两种使用方式:
7
- * 1. defineNotesTheme() 工厂函数(推荐)
8
- * 2. export default(向后兼容)
9
- *
10
- * doc:
11
- * v1 - https://vuejs.github.io/vitepress/v1/zh/guide/custom-theme
12
- * v2 - https://vitepress.dev/zh/guide/custom-theme
13
- */
14
-
15
- import DefaultTheme from 'vitepress/theme'
16
-
17
- import BilibiliOutsidePlayer from '../components/BilibiliOutsidePlayer/BilibiliOutsidePlayer.vue'
18
- import Discussions from '../components/Discussions/Discussions.vue'
19
- import EnWordList from '../components/EnWordList/EnWordList.vue'
20
- import Footprints from '../components/Footprints/Footprints.vue'
21
- import { useRenameOverlay } from '../components/Layout/composables/useRenameOverlay'
22
- import { redirectAfterRename } from '../components/Layout/composables/useRenameRedirect'
23
- import Layout from '../components/Layout/Layout.vue'
24
- import MarkMap from '../components/MarkMap/MarkMap.vue'
25
- import Mermaid from '../components/Mermaid/Mermaid.vue'
26
- import NotesTable from '../components/NotesTable/NotesTable.vue'
27
- import Settings from '../components/Settings/Settings.vue'
28
- import SidebarCard from '../components/SidebarCard/SidebarCard.vue'
29
- import Tooltip from '../components/Tooltip/Tooltip.vue'
30
-
31
- import type { Theme, EnhanceAppContext } from 'vitepress'
32
- import './styles/index.scss'
33
-
34
- /**
35
- * 注册 TNotes 核心全局组件
36
- */
37
- function registerCoreComponents(ctx: EnhanceAppContext) {
38
- const { app } = ctx
39
- app.component('BilibiliOutsidePlayer', BilibiliOutsidePlayer)
40
- app.component('B', BilibiliOutsidePlayer)
41
- app.component('Discussions', Discussions)
42
- app.component('EnWordList', EnWordList)
43
- app.component('E', EnWordList)
44
- app.component('Footprints', Footprints)
45
- app.component('F', Footprints)
46
- app.component('Settings', Settings)
47
- app.component('S', Settings)
48
- app.component('SidebarCard', SidebarCard)
49
- app.component('MarkMap', MarkMap)
50
- app.component('Mermaid', Mermaid)
51
- app.component('NotesTable', NotesTable)
52
- app.component('N', NotesTable)
53
- app.component('Tooltip', Tooltip)
54
- }
55
-
56
- /**
57
- * 在 dev server 中监听文件夹直接重命名事件,
58
- * 当当前页面路径属于被重命名的文件夹时,自动跳转到新 URL。
59
- */
60
- function registerRenameHmrListener() {
61
- if (typeof window === 'undefined') return
62
- if (typeof import.meta.hot === 'undefined' || !import.meta.hot) return
63
-
64
- const overlay = useRenameOverlay()
65
- let handling = false
66
-
67
- import.meta.hot.on(
68
- 'tnotes:note-renamed',
69
- async (payload: {
70
- oldFolder?: string
71
- newFolder?: string
72
- noteIndex?: string
73
- }) => {
74
- if (handling) return
75
- if (!payload?.oldFolder || !payload?.newFolder) return
76
-
77
- const oldSegment = encodeURIComponent(payload.oldFolder)
78
- if (!window.location.pathname.includes(oldSegment)) return
79
-
80
- handling = true
81
- overlay.show({ message: '检测到文件夹重命名', tip: '正在跳转到新地址...' })
82
-
83
- try {
84
- await redirectAfterRename(
85
- `notes/${encodeURIComponent(payload.newFolder)}/README`,
86
- )
87
- } finally {
88
- handling = false
89
- }
90
- },
91
- )
92
- }
93
-
94
- /**
95
- * 覆盖选项
96
- */
97
- interface NotesThemeOverrides {
98
- /** 覆盖 Layout 组件 */
99
- Layout?: Theme['Layout']
100
- /** 追加的 enhanceApp 逻辑(在核心组件注册之后调用) */
101
- enhanceApp?: Theme['enhanceApp']
102
- }
103
-
104
- /**
105
- * 创建 TNotes 主题配置
106
- *
107
- * @param overrides - 可选的覆盖选项
108
- * @returns VitePress 主题对象
109
- *
110
- * @example
111
- * // .vitepress/theme/index.ts
112
- * import { defineNotesTheme } from '../tnotes/vitepress/theme'
113
- * export default defineNotesTheme()
114
- */
115
- export function defineNotesTheme(overrides: NotesThemeOverrides = {}): Theme {
116
- return {
117
- extends: DefaultTheme,
118
- Layout: overrides.Layout ?? Layout,
119
- enhanceApp(ctx) {
120
- registerCoreComponents(ctx)
121
- registerRenameHmrListener()
122
- overrides.enhanceApp?.(ctx)
123
- },
124
- }
125
- }
126
-
127
- /**
128
- * 默认导出(向后兼容旧版 re-export 方式)
129
- */
130
- export default {
131
- extends: DefaultTheme,
132
- Layout,
133
- enhanceApp(ctx: EnhanceAppContext) {
134
- registerCoreComponents(ctx)
135
- registerRenameHmrListener()
136
- },
137
- } satisfies Theme
1
+ /**
2
+ * .vitepress/tnotes/theme/index.ts
3
+ *
4
+ * 自定义主题
5
+ *
6
+ * 提供两种使用方式:
7
+ * 1. defineNotesTheme() 工厂函数(推荐)
8
+ * 2. export default(向后兼容)
9
+ *
10
+ * doc:
11
+ * v1 - https://vuejs.github.io/vitepress/v1/zh/guide/custom-theme
12
+ * v2 - https://vitepress.dev/zh/guide/custom-theme
13
+ */
14
+
15
+ import DefaultTheme from 'vitepress/theme'
16
+
17
+ import BilibiliOutsidePlayer from '../components/BilibiliOutsidePlayer/BilibiliOutsidePlayer.vue'
18
+ import Discussions from '../components/Discussions/Discussions.vue'
19
+ import EnWordList from '../components/EnWordList/EnWordList.vue'
20
+ import Footprints from '../components/Footprints/Footprints.vue'
21
+ import { useRenameOverlay } from '../components/Layout/composables/useRenameOverlay'
22
+ import { redirectAfterRename } from '../components/Layout/composables/useRenameRedirect'
23
+ import Layout from '../components/Layout/Layout.vue'
24
+ import MarkMap from '../components/MarkMap/MarkMap.vue'
25
+ import Mermaid from '../components/Mermaid/Mermaid.vue'
26
+ import NotesTable from '../components/NotesTable/NotesTable.vue'
27
+ import Settings from '../components/Settings/Settings.vue'
28
+ import SidebarCard from '../components/SidebarCard/SidebarCard.vue'
29
+ import Tooltip from '../components/Tooltip/Tooltip.vue'
30
+
31
+ import type { Theme, EnhanceAppContext } from 'vitepress'
32
+ import './styles/index.scss'
33
+
34
+ /**
35
+ * 注册 TNotes 核心全局组件
36
+ */
37
+ function registerCoreComponents(ctx: EnhanceAppContext) {
38
+ const { app } = ctx
39
+ app.component('BilibiliOutsidePlayer', BilibiliOutsidePlayer)
40
+ app.component('B', BilibiliOutsidePlayer)
41
+ app.component('Discussions', Discussions)
42
+ app.component('EnWordList', EnWordList)
43
+ app.component('E', EnWordList)
44
+ app.component('Footprints', Footprints)
45
+ app.component('F', Footprints)
46
+ app.component('Settings', Settings)
47
+ app.component('S', Settings)
48
+ app.component('SidebarCard', SidebarCard)
49
+ app.component('MarkMap', MarkMap)
50
+ app.component('Mermaid', Mermaid)
51
+ app.component('NotesTable', NotesTable)
52
+ app.component('N', NotesTable)
53
+ app.component('Tooltip', Tooltip)
54
+ }
55
+
56
+ /**
57
+ * 在 dev server 中监听文件夹直接重命名事件,
58
+ * 当当前页面路径属于被重命名的文件夹时,自动跳转到新 URL。
59
+ */
60
+ function registerRenameHmrListener() {
61
+ if (typeof window === 'undefined') return
62
+ if (typeof import.meta.hot === 'undefined' || !import.meta.hot) return
63
+
64
+ const overlay = useRenameOverlay()
65
+ let handling = false
66
+
67
+ import.meta.hot.on(
68
+ 'tnotes:note-renamed',
69
+ async (payload: {
70
+ oldFolder?: string
71
+ newFolder?: string
72
+ noteIndex?: string
73
+ }) => {
74
+ if (handling) return
75
+ if (!payload?.oldFolder || !payload?.newFolder) return
76
+
77
+ const oldSegment = encodeURIComponent(payload.oldFolder)
78
+ if (!window.location.pathname.includes(oldSegment)) return
79
+
80
+ handling = true
81
+ overlay.show({ message: '检测到文件夹重命名', tip: '正在跳转到新地址...' })
82
+
83
+ try {
84
+ await redirectAfterRename(
85
+ `notes/${encodeURIComponent(payload.newFolder)}/README`,
86
+ )
87
+ } finally {
88
+ handling = false
89
+ }
90
+ },
91
+ )
92
+ }
93
+
94
+ /**
95
+ * 覆盖选项
96
+ */
97
+ interface NotesThemeOverrides {
98
+ /** 覆盖 Layout 组件 */
99
+ Layout?: Theme['Layout']
100
+ /** 追加的 enhanceApp 逻辑(在核心组件注册之后调用) */
101
+ enhanceApp?: Theme['enhanceApp']
102
+ }
103
+
104
+ /**
105
+ * 创建 TNotes 主题配置
106
+ *
107
+ * @param overrides - 可选的覆盖选项
108
+ * @returns VitePress 主题对象
109
+ *
110
+ * @example
111
+ * // .vitepress/theme/index.ts
112
+ * import { defineNotesTheme } from '../tnotes/vitepress/theme'
113
+ * export default defineNotesTheme()
114
+ */
115
+ export function defineNotesTheme(overrides: NotesThemeOverrides = {}): Theme {
116
+ return {
117
+ extends: DefaultTheme,
118
+ Layout: overrides.Layout ?? Layout,
119
+ enhanceApp(ctx) {
120
+ registerCoreComponents(ctx)
121
+ registerRenameHmrListener()
122
+ overrides.enhanceApp?.(ctx)
123
+ },
124
+ }
125
+ }
126
+
127
+ /**
128
+ * 默认导出(向后兼容旧版 re-export 方式)
129
+ */
130
+ export default {
131
+ extends: DefaultTheme,
132
+ Layout,
133
+ enhanceApp(ctx: EnhanceAppContext) {
134
+ registerCoreComponents(ctx)
135
+ registerRenameHmrListener()
136
+ },
137
+ } satisfies Theme
@@ -1,64 +1,66 @@
1
- /**
2
- * 基础样式层
3
- * - CSS 自定义属性(变量)
4
- * - 全局样式重置
5
- * - 通用样式规则
6
- */
7
-
8
- /* ===================================== */
9
- /* #region CSS 变量定义 */
10
- /* ===================================== */
11
-
12
- :root {
13
- /* 品牌色 */
14
- --vp-c-brand-1: #646cff;
15
- --vp-c-brand-2: #747bff;
16
- }
17
-
18
- /* #endregion */
19
-
20
- /* ===================================== */
21
- /* #region 全局样式重置 */
22
- /* ===================================== */
23
-
24
- /* 移除所有链接的下划线 */
25
- a {
26
- text-decoration: none !important;
27
- }
28
-
29
- /* 任务列表样式优化 */
30
- ul > li.task-list-item {
31
- list-style-type: none;
32
- padding-left: 0;
33
- margin-left: 0;
34
- }
35
-
36
- ul > li.task-list-item > ul {
37
- padding-left: 3rem;
38
- }
39
-
40
- .vp-doc h2 {
41
- // margin 默认值:
42
- // margin: 48px 0 16px;
43
- // 缩小上边距
44
- margin: 1rem 0 1rem;
45
- // border-top 默认值:
46
- // border-top: 1px solid var(--vp-c-divider);
47
- // 移除上横线:
48
- border-top: none;
49
- }
50
-
51
- /* 修复锚点定位:为标题添加滚动偏移,避免被顶部固定导航栏遮挡 */
52
- .vp-doc :is(h1, h2, h3, h4, h5, h6) {
53
- scroll-margin-top: calc(var(--vp-nav-height) + 1rem);
54
- }
55
-
56
- // 代码块外层 div
57
- .vp-doc div[class*=language-] {
58
- // 默认值:
59
- // margin: 16px 24px;
60
- // 移除左右 margin:
61
- margin: 16px 0 !important;
62
- }
63
-
64
- /* #endregion */
1
+ /**
2
+ * 基础样式层
3
+ * - CSS 自定义属性(变量)
4
+ * - 全局样式重置
5
+ * - 通用样式规则
6
+ */
7
+
8
+ /* ===================================== */
9
+ /* #region CSS 变量定义 */
10
+ /* ===================================== */
11
+
12
+ :root {
13
+ /* 品牌色 */
14
+ --vp-c-brand-1: #646cff;
15
+ --vp-c-brand-2: #747bff;
16
+ }
17
+
18
+ /* #endregion */
19
+
20
+ /* ===================================== */
21
+ /* #region 全局样式重置 */
22
+ /* ===================================== */
23
+
24
+ /* 移除所有链接的下划线 */
25
+ a {
26
+ text-decoration: none !important;
27
+ }
28
+
29
+ /* 任务列表样式优化 */
30
+ ul > li.task-list-item {
31
+ list-style-type: none;
32
+ padding-left: 0;
33
+ margin-left: 0;
34
+ }
35
+
36
+ ul > li.task-list-item > ul {
37
+ padding-left: 3rem;
38
+ }
39
+
40
+ .vp-doc h2 {
41
+ // margin 默认值:
42
+ // margin: 48px 0 16px;
43
+ // 缩小上边距
44
+ margin: 1rem 0 1rem;
45
+ // border-top 默认值:
46
+ // border-top: 1px solid var(--vp-c-divider);
47
+ // 移除上横线:
48
+ border-top: none;
49
+ }
50
+
51
+ .vp-doc :is(h1, h2, h3, h4, h5, h6) {
52
+ /* 修复锚点定位:为标题添加滚动偏移,避免被顶部固定导航栏遮挡 */
53
+ scroll-margin-top: calc(var(--vp-nav-height) + 1rem);
54
+ /* 所有标题统一上下边距 */
55
+ margin: 1rem 0 1rem;
56
+ }
57
+
58
+ // 代码块外层 div
59
+ .vp-doc div[class*=language-] {
60
+ // 默认值:
61
+ // margin: 16px 24px;
62
+ // 移除 margin:
63
+ margin: 0px !important;
64
+ }
65
+
66
+ /* #endregion */
@@ -1,31 +1,31 @@
1
- /**
2
- * ./vitepress/tnotes/vitepress/theme/styles/components/404.scss
3
- *
4
- * 404 页面样式
5
- */
6
-
7
- .not-found-container {
8
- text-align: center;
9
- padding: 2rem;
10
- min-height: calc(100vh - var(--vp-nav-height));
11
- display: flex;
12
- flex-direction: column;
13
- justify-content: center;
14
- align-items: center;
15
- animation: fadeIn 0.4s ease-out;
16
- }
17
-
18
- .not-found-container h1 {
19
- font-size: 4rem;
20
- line-height: 4rem;
21
- margin-bottom: 1rem;
22
- background: linear-gradient(135deg, var(--vp-c-brand-1), var(--vp-c-brand-2));
23
- -webkit-background-clip: text;
24
- -webkit-text-fill-color: transparent;
25
- background-clip: text;
26
- }
27
-
28
- .not-found-container p {
29
- font-size: 1.5rem;
30
- color: var(--vp-c-text-2);
31
- }
1
+ /**
2
+ * ./vitepress/tnotes/vitepress/theme/styles/components/404.scss
3
+ *
4
+ * 404 页面样式
5
+ */
6
+
7
+ .not-found-container {
8
+ text-align: center;
9
+ padding: 2rem;
10
+ min-height: calc(100vh - var(--vp-nav-height));
11
+ display: flex;
12
+ flex-direction: column;
13
+ justify-content: center;
14
+ align-items: center;
15
+ animation: fadeIn 0.4s ease-out;
16
+ }
17
+
18
+ .not-found-container h1 {
19
+ font-size: 4rem;
20
+ line-height: 4rem;
21
+ margin-bottom: 1rem;
22
+ background: linear-gradient(135deg, var(--vp-c-brand-1), var(--vp-c-brand-2));
23
+ -webkit-background-clip: text;
24
+ -webkit-text-fill-color: transparent;
25
+ background-clip: text;
26
+ }
27
+
28
+ .not-found-container p {
29
+ font-size: 1.5rem;
30
+ color: var(--vp-c-text-2);
31
+ }