@vuepress/theme-default 2.0.0-rc.5 → 2.0.0-rc.52

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 (141) hide show
  1. package/lib/client/components/VPDarkIcon.vue +8 -0
  2. package/lib/client/components/VPDropdownTransition.vue +36 -0
  3. package/lib/client/components/VPEditIcon.vue +12 -0
  4. package/lib/client/components/VPHome.vue +38 -0
  5. package/lib/client/components/VPHomeFeatures.vue +66 -0
  6. package/lib/client/components/{HomeFooter.vue → VPHomeFooter.vue} +17 -2
  7. package/lib/client/components/{HomeHero.vue → VPHomeHero.vue} +113 -19
  8. package/lib/client/components/VPLightIcon.vue +28 -0
  9. package/lib/client/components/VPNavbar.vue +134 -0
  10. package/lib/client/components/{NavbarBrand.vue → VPNavbarBrand.vue} +40 -7
  11. package/lib/client/components/VPNavbarDropdown.vue +320 -0
  12. package/lib/client/components/VPNavbarItems.vue +111 -0
  13. package/lib/client/components/VPPage.vue +70 -0
  14. package/lib/client/components/VPPageMeta.vue +132 -0
  15. package/lib/client/components/VPPageNav.vue +118 -0
  16. package/lib/client/components/VPSidebar.vue +113 -0
  17. package/lib/client/components/VPSidebarItem.vue +174 -0
  18. package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +32 -7
  19. package/lib/client/components/VPToggleColorModeButton.vue +55 -0
  20. package/lib/client/components/VPToggleSidebarButton.vue +92 -0
  21. package/lib/client/components/global/Badge.vue +84 -18
  22. package/lib/client/components/global/index.d.ts +1 -3
  23. package/lib/client/components/global/index.js +1 -3
  24. package/lib/client/composables/index.d.ts +8 -0
  25. package/lib/client/composables/index.js +8 -0
  26. package/lib/client/composables/useContributors.d.ts +3 -0
  27. package/lib/client/composables/useContributors.js +14 -0
  28. package/lib/client/composables/useDarkMode.d.ts +0 -1
  29. package/lib/client/composables/useDarkMode.js +16 -13
  30. package/lib/client/composables/useEditLink.d.ts +3 -0
  31. package/lib/client/composables/useEditLink.js +31 -0
  32. package/lib/client/composables/useLastUpdated.d.ts +2 -0
  33. package/lib/client/composables/useLastUpdated.js +17 -0
  34. package/lib/client/composables/useNavbarConfig.d.ts +3 -0
  35. package/lib/client/composables/useNavbarConfig.js +27 -0
  36. package/lib/client/composables/useNavbarRepo.d.ts +6 -0
  37. package/lib/client/composables/useNavbarRepo.js +38 -0
  38. package/lib/client/composables/useNavbarSelectLanguage.d.ts +6 -0
  39. package/lib/client/composables/useNavbarSelectLanguage.js +59 -0
  40. package/lib/client/composables/useNavigate.d.ts +1 -0
  41. package/lib/client/composables/useNavigate.js +22 -0
  42. package/lib/client/composables/useRelatedLinks.d.ts +8 -0
  43. package/lib/client/composables/useRelatedLinks.js +91 -0
  44. package/lib/client/composables/useScrollPromise.js +3 -1
  45. package/lib/client/composables/useSidebarItems.d.ts +28 -23
  46. package/lib/client/composables/useSidebarItems.js +120 -84
  47. package/lib/client/composables/useUpdateDeviceStatus.d.ts +1 -1
  48. package/lib/client/composables/useUpdateDeviceStatus.js +10 -5
  49. package/lib/client/config.d.ts +3 -2
  50. package/lib/client/config.js +9 -22
  51. package/lib/client/index.d.ts +2 -1
  52. package/lib/client/index.js +0 -1
  53. package/lib/client/layouts/Layout.vue +139 -34
  54. package/lib/client/layouts/NotFound.vue +17 -5
  55. package/lib/client/shim.d.ts +12 -3
  56. package/lib/client/styles/_mixins.scss +4 -4
  57. package/lib/client/styles/_variables.module.scss +1 -1
  58. package/lib/client/styles/_variables.scss +1 -0
  59. package/lib/client/styles/arrow.scss +18 -24
  60. package/lib/client/styles/code-group.scss +35 -30
  61. package/lib/client/styles/content/code.scss +23 -0
  62. package/lib/client/styles/content/index.scss +3 -0
  63. package/lib/client/styles/content/normalize.scss +39 -0
  64. package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
  65. package/lib/client/styles/external-link-icon.scss +37 -0
  66. package/lib/client/styles/index.scss +3 -13
  67. package/lib/client/styles/layout.scss +3 -199
  68. package/lib/client/styles/normalize.scss +1 -194
  69. package/lib/client/styles/plugins.scss +28 -0
  70. package/lib/client/styles/vars-dark.scss +20 -58
  71. package/lib/client/styles/vars.scss +53 -129
  72. package/lib/client/typings.d.ts +13 -0
  73. package/lib/client/typings.js +1 -0
  74. package/lib/client/utils/getAutoLink.d.ts +9 -0
  75. package/lib/client/utils/getAutoLink.js +17 -0
  76. package/lib/client/utils/index.d.ts +3 -2
  77. package/lib/client/utils/index.js +3 -2
  78. package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
  79. package/lib/client/utils/isActiveSidebarItem.js +3 -3
  80. package/lib/client/utils/isLinkInternal.d.ts +1 -0
  81. package/lib/client/utils/isLinkInternal.js +2 -0
  82. package/lib/client/utils/resolveEditLink.d.ts +1 -1
  83. package/lib/client/utils/resolvePrefix.d.ts +1 -0
  84. package/lib/client/utils/resolvePrefix.js +4 -0
  85. package/lib/client/utils/resolveRepoType.d.ts +1 -1
  86. package/lib/client/utils/resolveRepoType.js +4 -4
  87. package/lib/node/defaultTheme.d.ts +2 -1
  88. package/lib/node/defaultTheme.js +72 -46
  89. package/lib/node/index.d.ts +3 -1
  90. package/lib/node/index.js +1 -1
  91. package/lib/node/typings.d.ts +58 -0
  92. package/lib/node/typings.js +1 -0
  93. package/lib/node/utils/assignDefaultLocaleOptions.js +3 -7
  94. package/lib/node/utils/index.d.ts +1 -1
  95. package/lib/node/utils/index.js +1 -1
  96. package/lib/node/utils/resolveMarkdownHintLocales.d.ts +9 -0
  97. package/lib/node/utils/resolveMarkdownHintLocales.js +19 -0
  98. package/lib/shared/index.d.ts +5 -3
  99. package/lib/shared/index.js +1 -3
  100. package/lib/shared/nav.d.ts +19 -30
  101. package/lib/shared/navbar.d.ts +21 -0
  102. package/lib/shared/navbar.js +1 -0
  103. package/lib/shared/options.d.ts +36 -60
  104. package/lib/shared/page.d.ts +9 -6
  105. package/lib/shared/sidebar.d.ts +26 -0
  106. package/lib/shared/sidebar.js +1 -0
  107. package/package.json +30 -26
  108. package/templates/build.html +23 -14
  109. package/lib/client/components/AutoLink.vue +0 -113
  110. package/lib/client/components/DropdownTransition.vue +0 -25
  111. package/lib/client/components/Home.vue +0 -15
  112. package/lib/client/components/HomeContent.vue +0 -5
  113. package/lib/client/components/HomeFeatures.vue +0 -22
  114. package/lib/client/components/Navbar.vue +0 -79
  115. package/lib/client/components/NavbarDropdown.vue +0 -126
  116. package/lib/client/components/NavbarItems.vue +0 -199
  117. package/lib/client/components/Page.vue +0 -31
  118. package/lib/client/components/PageMeta.vue +0 -124
  119. package/lib/client/components/PageNav.vue +0 -122
  120. package/lib/client/components/Sidebar.vue +0 -18
  121. package/lib/client/components/SidebarItem.vue +0 -87
  122. package/lib/client/components/ToggleColorModeButton.vue +0 -57
  123. package/lib/client/components/ToggleSidebarButton.vue +0 -24
  124. package/lib/client/components/global/CodeGroup.d.ts +0 -6
  125. package/lib/client/components/global/CodeGroup.js +0 -120
  126. package/lib/client/components/global/CodeGroupItem.vue +0 -27
  127. package/lib/client/styles/badge.scss +0 -36
  128. package/lib/client/styles/code.scss +0 -263
  129. package/lib/client/styles/custom-container.scss +0 -142
  130. package/lib/client/styles/home.scss +0 -168
  131. package/lib/client/styles/navbar-dropdown.scss +0 -183
  132. package/lib/client/styles/navbar.scss +0 -197
  133. package/lib/client/styles/page.scss +0 -87
  134. package/lib/client/styles/sidebar.scss +0 -134
  135. package/lib/client/styles/transitions.scss +0 -22
  136. package/lib/client/utils/getNavLink.d.ts +0 -15
  137. package/lib/client/utils/getNavLink.js +0 -18
  138. package/lib/client/utils/getResolveRouteWithRedirect.d.ts +0 -5
  139. package/lib/client/utils/getResolveRouteWithRedirect.js +0 -22
  140. package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
  141. package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
@@ -1,8 +1,11 @@
1
+ import { addViteConfig, addViteOptimizeDepsExclude, chainWebpack, } from '@vuepress/helper';
1
2
  import { activeHeaderLinksPlugin } from '@vuepress/plugin-active-header-links';
2
3
  import { backToTopPlugin } from '@vuepress/plugin-back-to-top';
3
- import { containerPlugin } from '@vuepress/plugin-container';
4
- import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon';
4
+ import { copyCodePlugin } from '@vuepress/plugin-copy-code';
5
5
  import { gitPlugin } from '@vuepress/plugin-git';
6
+ import { linksCheckPlugin } from '@vuepress/plugin-links-check';
7
+ import { markdownHintPlugin } from '@vuepress/plugin-markdown-hint';
8
+ import { markdownTabPlugin } from '@vuepress/plugin-markdown-tab';
6
9
  import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom';
7
10
  import { nprogressPlugin } from '@vuepress/plugin-nprogress';
8
11
  import { palettePlugin } from '@vuepress/plugin-palette';
@@ -12,7 +15,7 @@ import { sitemapPlugin } from '@vuepress/plugin-sitemap';
12
15
  import { themeDataPlugin } from '@vuepress/plugin-theme-data';
13
16
  import { isPlainObject } from 'vuepress/shared';
14
17
  import { fs, getDirname, path } from 'vuepress/utils';
15
- import { assignDefaultLocaleOptions, resolveContainerPluginOptions, } from './utils/index.js';
18
+ import { assignDefaultLocaleOptions, resolveMarkdownHintLocales, } from './utils/index.js';
16
19
  const __dirname = getDirname(import.meta.url);
17
20
  export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } = {}) => {
18
21
  assignDefaultLocaleOptions(localeOptions);
@@ -28,8 +31,46 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
28
31
  `@theme/${file}`,
29
32
  path.resolve(__dirname, '../client/components', file),
30
33
  ])),
34
+ // use alias to make all composables replaceable
35
+ ...Object.fromEntries(fs
36
+ .readdirSync(path.resolve(__dirname, '../client/composables'))
37
+ .filter((file) => file.endsWith('.js'))
38
+ .map((file) => [
39
+ `@theme/${file.substring(0, file.length - 3)}`,
40
+ path.resolve(__dirname, '../client/composables', file),
41
+ ])),
31
42
  },
32
43
  clientConfigFile: path.resolve(__dirname, '../client/config.js'),
44
+ extendsBundlerOptions: (bundlerOptions, app) => {
45
+ // FIXME: hide sass deprecation warning for mixed-decls
46
+ addViteConfig(bundlerOptions, app, {
47
+ css: {
48
+ preprocessorOptions: {
49
+ sass: {
50
+ silenceDeprecations: ['mixed-decls'],
51
+ },
52
+ scss: {
53
+ silenceDeprecations: ['mixed-decls'],
54
+ },
55
+ },
56
+ },
57
+ });
58
+ chainWebpack(bundlerOptions, app, (config) => {
59
+ config.module
60
+ .rule('scss')
61
+ .use('sass-loader')
62
+ .tap((options) => ({
63
+ ...options,
64
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
65
+ sassOptions: {
66
+ silenceDeprecations: ['mixed-decls'],
67
+ ...options.sassOptions,
68
+ },
69
+ }));
70
+ });
71
+ // ensure theme alias is not optimized by Vite
72
+ addViteOptimizeDepsExclude(bundlerOptions, app, '@theme');
73
+ },
33
74
  extendsPage: (page) => {
34
75
  // save relative file path into page data to generate edit link
35
76
  page.data.filePathRelative = page.filePathRelative;
@@ -40,54 +81,27 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
40
81
  // @vuepress/plugin-active-header-link
41
82
  themePlugins.activeHeaderLinks !== false
42
83
  ? activeHeaderLinksPlugin({
43
- headerLinkSelector: 'a.sidebar-item',
44
- headerAnchorSelector: '.header-anchor',
45
84
  // should greater than page transition duration
46
85
  delay: 300,
47
86
  })
48
87
  : [],
49
88
  // @vuepress/plugin-back-to-top
50
- themePlugins.backToTop !== false ? backToTopPlugin() : [],
51
- // @vuepress/plugin-container
52
- themePlugins.container?.tip !== false
53
- ? containerPlugin(resolveContainerPluginOptions(localeOptions, 'tip'))
54
- : [],
55
- themePlugins.container?.warning !== false
56
- ? containerPlugin(resolveContainerPluginOptions(localeOptions, 'warning'))
57
- : [],
58
- themePlugins.container?.danger !== false
59
- ? containerPlugin(resolveContainerPluginOptions(localeOptions, 'danger'))
60
- : [],
61
- themePlugins.container?.details !== false
62
- ? containerPlugin({
63
- type: 'details',
64
- before: (info) => `<details class="custom-container details">${info ? `<summary>${info}</summary>` : ''}\n`,
65
- after: () => '</details>\n',
66
- })
67
- : [],
68
- themePlugins.container?.codeGroup !== false
69
- ? containerPlugin({
70
- type: 'code-group',
71
- before: () => `<CodeGroup>\n`,
72
- after: () => '</CodeGroup>\n',
73
- })
89
+ themePlugins.backToTop !== false
90
+ ? backToTopPlugin(isPlainObject(themePlugins.backToTop) ? themePlugins.backToTop : {})
74
91
  : [],
75
- themePlugins.container?.codeGroupItem !== false
76
- ? containerPlugin({
77
- type: 'code-group-item',
78
- before: (info) => `<CodeGroupItem title="${info}">\n`,
79
- after: () => '</CodeGroupItem>\n',
92
+ // @vuepress/plugin-copy-code
93
+ themePlugins.copyCode !== false
94
+ ? copyCodePlugin({
95
+ ...(isPlainObject(themePlugins.copyCode)
96
+ ? themePlugins.copyCode
97
+ : {}),
80
98
  })
81
99
  : [],
82
- // @vuepress/plugin-external-link-icon
83
- themePlugins.externalLinkIcon !== false
84
- ? externalLinkIconPlugin({
85
- locales: Object.entries(localeOptions.locales || {}).reduce((result, [key, value]) => {
86
- result[key] = {
87
- openInNewWindow: value.openInNewWindow ?? localeOptions.openInNewWindow,
88
- };
89
- return result;
90
- }, {}),
100
+ // @vuepress/plugin-markdown-container
101
+ themePlugins.hint !== false
102
+ ? markdownHintPlugin({
103
+ locales: resolveMarkdownHintLocales(localeOptions),
104
+ ...(isPlainObject(themePlugins.hint) ? themePlugins.hint : {}),
91
105
  })
92
106
  : [],
93
107
  // @vuepress/plugin-git
@@ -98,11 +112,15 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
98
112
  contributors: localeOptions.contributors !== false,
99
113
  })
100
114
  : [],
115
+ // @vuepress/plugin-links-check
116
+ themePlugins.linksCheck !== false
117
+ ? linksCheckPlugin(isPlainObject(themePlugins.linksCheck)
118
+ ? themePlugins.linksCheck
119
+ : {})
120
+ : [],
101
121
  // @vuepress/plugin-medium-zoom
102
122
  themePlugins.mediumZoom !== false
103
123
  ? mediumZoomPlugin({
104
- selector: '.theme-default-content > img, .theme-default-content :not(a) > img',
105
- zoomOptions: {},
106
124
  // should greater than page transition duration
107
125
  delay: 300,
108
126
  })
@@ -112,7 +130,9 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
112
130
  // @vuepress/plugin-palette
113
131
  palettePlugin({ preset: 'sass' }),
114
132
  // @vuepress/plugin-prismjs
115
- themePlugins.prismjs !== false ? prismjsPlugin() : [],
133
+ themePlugins.prismjs !== false
134
+ ? prismjsPlugin(isPlainObject(themePlugins.prismjs) ? themePlugins.prismjs : {})
135
+ : [],
116
136
  // @vuepress/plugin-seo
117
137
  hostname && themePlugins.seo !== false
118
138
  ? seoPlugin({
@@ -129,6 +149,12 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
129
149
  : {}),
130
150
  })
131
151
  : [],
152
+ // @vuepress/plugin-markdown-tab
153
+ themePlugins.tab !== false
154
+ ? markdownTabPlugin(isPlainObject(themePlugins.tab)
155
+ ? themePlugins.tab
156
+ : { codeTabs: true, tabs: true })
157
+ : [],
132
158
  // @vuepress/plugin-theme-data
133
159
  themeDataPlugin({ themeData: localeOptions }),
134
160
  ],
@@ -1,5 +1,7 @@
1
1
  import { defaultTheme } from './defaultTheme.js';
2
- export * from '../shared/index.js';
3
2
  export * from './defaultTheme.js';
3
+ export type * from './typings.js';
4
4
  export * from './utils/index.js';
5
+ export type * from '../shared/index.js';
6
+ /** @deprecated Use named export instead */
5
7
  export default defaultTheme;
package/lib/node/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { defaultTheme } from './defaultTheme.js';
2
- export * from '../shared/index.js';
3
2
  export * from './defaultTheme.js';
4
3
  export * from './utils/index.js';
4
+ /** @deprecated Use named export instead */
5
5
  export default defaultTheme;
@@ -0,0 +1,58 @@
1
+ import type { BackToTopPluginOptions } from '@vuepress/plugin-back-to-top';
2
+ import type { CopyCodePluginOptions } from '@vuepress/plugin-copy-code';
3
+ import type { LinksCheckPluginOptions } from '@vuepress/plugin-links-check';
4
+ import type { MarkdownHintPluginOptions } from '@vuepress/plugin-markdown-hint';
5
+ import type { MarkdownTabPluginOptions } from '@vuepress/plugin-markdown-tab';
6
+ import type { PrismjsPluginOptions } from '@vuepress/plugin-prismjs';
7
+ import type { SeoPluginOptions } from '@vuepress/plugin-seo';
8
+ import type { SitemapPluginOptions } from '@vuepress/plugin-sitemap';
9
+ export interface DefaultThemePluginsOptions {
10
+ /**
11
+ * Enable @vuepress/plugin-active-header-links or not
12
+ */
13
+ activeHeaderLinks?: boolean;
14
+ /**
15
+ * Enable @vuepress/plugin-back-to-top or not
16
+ */
17
+ backToTop?: BackToTopPluginOptions | boolean;
18
+ /**
19
+ * Enable @vuepress/plugin-copy-code or not
20
+ */
21
+ copyCode?: CopyCodePluginOptions | boolean;
22
+ /**
23
+ * Enable @vuepress/plugin-git or not
24
+ */
25
+ git?: boolean;
26
+ /**
27
+ * Enable @vuepress/plugin-markdown-hint or not
28
+ */
29
+ hint?: MarkdownHintPluginOptions | boolean;
30
+ /**
31
+ * Enable @vuepress/plugin-links-check or not
32
+ */
33
+ linksCheck?: LinksCheckPluginOptions | boolean;
34
+ /**
35
+ * Enable @vuepress/plugin-medium-zoom or not
36
+ */
37
+ mediumZoom?: boolean;
38
+ /**
39
+ * Enable @vuepress/plugin-nprogress or not
40
+ */
41
+ nprogress?: boolean;
42
+ /**
43
+ * Enable @vuepress/plugin-prismjs or not
44
+ */
45
+ prismjs?: PrismjsPluginOptions | boolean;
46
+ /**
47
+ * Enable @vuepress/plugin-seo or not
48
+ */
49
+ seo?: Partial<SeoPluginOptions> | boolean;
50
+ /**
51
+ * Enable @vuepress/plugin-sitemap or not
52
+ */
53
+ sitemap?: Partial<SitemapPluginOptions> | boolean;
54
+ /**
55
+ * Enable @vuepress/plugin-markdown-tab or not
56
+ */
57
+ tab?: MarkdownTabPluginOptions | boolean;
58
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -9,7 +9,7 @@ export const DEFAULT_LOCALE_OPTIONS = {
9
9
  selectLanguageText: 'Languages',
10
10
  selectLanguageAriaLabel: 'Select language',
11
11
  // sidebar
12
- sidebar: 'auto',
12
+ sidebar: 'heading',
13
13
  sidebarDepth: 2,
14
14
  // page meta
15
15
  editLink: true,
@@ -39,16 +39,12 @@ export const DEFAULT_LOCALE_DATA = {
39
39
  * Assign default options
40
40
  */
41
41
  export const assignDefaultLocaleOptions = (localeOptions) => {
42
- if (!localeOptions.locales) {
43
- localeOptions.locales = {};
44
- }
45
- if (!localeOptions.locales['/']) {
46
- localeOptions.locales['/'] = {};
47
- }
42
+ localeOptions.locales ??= {};
48
43
  Object.assign(localeOptions, {
49
44
  ...DEFAULT_LOCALE_OPTIONS,
50
45
  ...localeOptions,
51
46
  });
47
+ localeOptions.locales['/'] ??= {};
52
48
  Object.assign(localeOptions.locales['/'], {
53
49
  ...DEFAULT_LOCALE_DATA,
54
50
  ...localeOptions.locales['/'],
@@ -1,2 +1,2 @@
1
1
  export * from './assignDefaultLocaleOptions.js';
2
- export * from './resolveContainerPluginOptions.js';
2
+ export * from './resolveMarkdownHintLocales.js';
@@ -1,2 +1,2 @@
1
1
  export * from './assignDefaultLocaleOptions.js';
2
- export * from './resolveContainerPluginOptions.js';
2
+ export * from './resolveMarkdownHintLocales.js';
@@ -0,0 +1,9 @@
1
+ import type { MarkdownHintPluginLocaleData } from '@vuepress/plugin-markdown-hint';
2
+ import type { LocaleConfig } from 'vuepress/shared';
3
+ import type { DefaultThemeData } from '../../shared/index.js';
4
+ /**
5
+ * Resolve options for @vuepress/plugin-markdown-container
6
+ *
7
+ * For custom containers default title
8
+ */
9
+ export declare const resolveMarkdownHintLocales: (localeOptions: DefaultThemeData) => LocaleConfig<MarkdownHintPluginLocaleData>;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Resolve options for @vuepress/plugin-markdown-container
3
+ *
4
+ * For custom containers default title
5
+ */
6
+ export const resolveMarkdownHintLocales = (localeOptions) => Object.entries(localeOptions.locales ?? {}).reduce((result, [key, value]) => {
7
+ result[key] = {};
8
+ if (value.tip)
9
+ result[key].tip = value.tip;
10
+ if (value.warning)
11
+ result[key].warning = value.warning;
12
+ if (value.danger)
13
+ result[key].caution = value.danger;
14
+ if (value.important)
15
+ result[key].important = value.important;
16
+ if (value.note)
17
+ result[key].note = value.note;
18
+ return result;
19
+ }, {});
@@ -1,3 +1,5 @@
1
- export * from './nav.js';
2
- export * from './options.js';
3
- export * from './page.js';
1
+ export type * from './nav.js';
2
+ export type * from './navbar.js';
3
+ export type * from './options.js';
4
+ export type * from './page.js';
5
+ export type * from './sidebar.js';
@@ -1,3 +1 @@
1
- export * from './nav.js';
2
- export * from './options.js';
3
- export * from './page.js';
1
+ export {};
@@ -1,43 +1,32 @@
1
1
  /**
2
2
  * Base nav item, displayed as text
3
3
  */
4
- export interface NavItem {
4
+ export interface NavItemOptions {
5
5
  text: string;
6
6
  ariaLabel?: string;
7
7
  }
8
8
  /**
9
- * Base nav group, has nav items children
9
+ * Options for `<AutoLink>`
10
10
  */
11
- export interface NavGroup<T> extends NavItem {
12
- children: T[];
13
- }
14
- /**
15
- * Props for `<AutoLink>`
16
- */
17
- export interface NavLink extends NavItem {
11
+ export interface AutoLinkOptions extends NavItemOptions {
12
+ /**
13
+ * Link of item
14
+ */
18
15
  link: string;
16
+ /**
17
+ * Rel of `<a>` tag
18
+ */
19
19
  rel?: string;
20
+ /**
21
+ * Target of `<a>` tag
22
+ */
20
23
  target?: string;
24
+ /**
25
+ * Regexp mode to be active
26
+ */
21
27
  activeMatch?: string;
28
+ /**
29
+ * Whether it's active only when exact match
30
+ */
31
+ exact?: boolean;
22
32
  }
23
- /**
24
- * Navbar types
25
- */
26
- export type NavbarItem = NavLink;
27
- export type NavbarGroup = NavGroup<NavbarGroup | NavbarItem | string>;
28
- export type NavbarConfig = (NavbarItem | NavbarGroup | string)[];
29
- export type ResolvedNavbarItem = NavbarItem | NavGroup<ResolvedNavbarItem>;
30
- /**
31
- * Sidebar types
32
- */
33
- export type SidebarItem = NavItem & Partial<NavLink>;
34
- export type SidebarGroup = SidebarItem & NavGroup<SidebarItem | SidebarGroup | string> & {
35
- collapsible?: boolean;
36
- };
37
- export type SidebarConfigArray = (SidebarItem | SidebarGroup | string)[];
38
- export type SidebarConfigObjectItem = SidebarConfigArray | 'heading';
39
- export type SidebarConfigObject = Record<string, SidebarConfigObjectItem>;
40
- export type SidebarConfig = SidebarConfigArray | SidebarConfigObject;
41
- export type ResolvedSidebarItem = SidebarItem & Partial<NavGroup<ResolvedSidebarItem>> & {
42
- collapsible?: boolean;
43
- };
@@ -0,0 +1,21 @@
1
+ import type { AutoLinkOptions, NavItemOptions } from './nav.js';
2
+ /**
3
+ * Base nav group, has nav items children
4
+ */
5
+ export interface NavGroup<T> extends NavItemOptions {
6
+ /**
7
+ * Link prefix of current group
8
+ */
9
+ prefix?: string;
10
+ /**
11
+ * Link of current group
12
+ */
13
+ link?: string;
14
+ /**
15
+ * Children of current group
16
+ */
17
+ children: T[];
18
+ }
19
+ export type NavbarLinkOptions = AutoLinkOptions | string;
20
+ export type NavbarGroupOptions = NavGroup<NavbarLinkOptions | NavGroup<NavbarLinkOptions>>;
21
+ export type NavbarOptions = (NavbarGroupOptions | NavbarLinkOptions)[] | false;
@@ -0,0 +1 @@
1
+ export {};
@@ -1,57 +1,7 @@
1
- import type { SeoPluginOptions } from '@vuepress/plugin-seo';
2
- import type { SitemapPluginOptions } from '@vuepress/plugin-sitemap';
3
1
  import type { ThemeData } from '@vuepress/plugin-theme-data';
4
2
  import type { LocaleData } from 'vuepress/shared';
5
- import type { NavbarConfig, SidebarConfig } from './nav.js';
6
- export interface DefaultThemePluginsOptions {
7
- /**
8
- * Enable @vuepress/plugin-active-header-links or not
9
- */
10
- activeHeaderLinks?: boolean;
11
- /**
12
- * Enable @vuepress/plugin-back-to-top or not
13
- */
14
- backToTop?: boolean;
15
- /**
16
- * Enable @vuepress/plugin-container or not
17
- */
18
- container?: {
19
- tip?: boolean;
20
- warning?: boolean;
21
- danger?: boolean;
22
- details?: boolean;
23
- codeGroup?: boolean;
24
- codeGroupItem?: boolean;
25
- };
26
- /**
27
- * Enable @vuepress/plugin-external-link-icon or not
28
- */
29
- externalLinkIcon?: boolean;
30
- /**
31
- * Enable @vuepress/plugin-git or not
32
- */
33
- git?: boolean;
34
- /**
35
- * Enable @vuepress/plugin-medium-zoom or not
36
- */
37
- mediumZoom?: boolean;
38
- /**
39
- * Enable @vuepress/plugin-nprogress or not
40
- */
41
- nprogress?: boolean;
42
- /**
43
- * Enable @vuepress/plugin-prismjs or not
44
- */
45
- prismjs?: boolean;
46
- /**
47
- * Enable @vuepress/plugin-seo or not
48
- */
49
- seo?: Partial<SeoPluginOptions> | boolean;
50
- /**
51
- * Enable @vuepress/plugin-sitemap or not
52
- */
53
- sitemap?: Partial<SitemapPluginOptions> | boolean;
54
- }
3
+ import type { NavbarOptions } from './navbar.js';
4
+ import type { SidebarOptions } from './sidebar.js';
55
5
  export type DefaultThemeLocaleOptions = DefaultThemeData;
56
6
  export type DefaultThemeData = ThemeData<DefaultThemeLocaleData>;
57
7
  export interface DefaultThemeLocaleData extends LocaleData {
@@ -67,6 +17,12 @@ export interface DefaultThemeLocaleData extends LocaleData {
67
17
  * @default true
68
18
  */
69
19
  colorModeSwitch?: boolean;
20
+ /**
21
+ * Whether show external link icon
22
+ *
23
+ * @default true
24
+ */
25
+ externalLinkIcon?: boolean;
70
26
  /**
71
27
  * Home path of current locale
72
28
  *
@@ -78,40 +34,40 @@ export interface DefaultThemeLocaleData extends LocaleData {
78
34
  *
79
35
  * Set to `false` to disable navbar in current locale
80
36
  */
81
- navbar?: false | NavbarConfig;
37
+ navbar?: NavbarOptions | false;
82
38
  /**
83
39
  * Navbar label used for screen readers using the `aria-label` attribute
84
40
  */
85
- navbarLabel?: null | string;
41
+ navbarLabel?: string | null;
86
42
  /**
87
43
  * Page navbar label used for screen readers using the `aria-label` attribute
88
44
  */
89
- pageNavbarLabel?: null | string;
45
+ pageNavbarLabel?: string | null;
90
46
  /**
91
47
  * Navbar logo config
92
48
  *
93
49
  * Logo to display in navbar
94
50
  */
95
- logo?: null | string;
51
+ logo?: string | null;
96
52
  /**
97
53
  * Navbar logo config for dark mode
98
54
  *
99
55
  * Logo to display in navbar in dark mode
100
56
  */
101
- logoDark?: null | string;
57
+ logoDark?: string | null;
102
58
  /**
103
59
  * The alt text of navbar logo.
104
60
  * Defaults to the site title if not specified.
105
61
  * If the value is the same as the site title, the site title rendered in the navbar will be
106
62
  * hidden from screen readers to avoid duplication.
107
63
  */
108
- logoAlt?: null | string;
64
+ logoAlt?: string | null;
109
65
  /**
110
66
  * Navbar repository config
111
67
  *
112
68
  * Used for the repository link of navbar
113
69
  */
114
- repo?: null | string;
70
+ repo?: string | null;
115
71
  /**
116
72
  * Navbar repository config
117
73
  *
@@ -143,7 +99,7 @@ export interface DefaultThemeLocaleData extends LocaleData {
143
99
  *
144
100
  * Set to `false` to disable sidebar in current locale
145
101
  */
146
- sidebar?: 'auto' | false | SidebarConfig;
102
+ sidebar?: SidebarOptions | false;
147
103
  /**
148
104
  * Sidebar depth
149
105
  *
@@ -241,6 +197,18 @@ export interface DefaultThemeLocaleData extends LocaleData {
241
197
  * Default title of DANGER custom block
242
198
  */
243
199
  danger?: string;
200
+ /**
201
+ * Custom block config
202
+ *
203
+ * Default title of IMPORTANT custom block
204
+ */
205
+ important?: string;
206
+ /**
207
+ * Custom block config
208
+ *
209
+ * Default title of NOTE custom block
210
+ */
211
+ note?: string;
244
212
  /**
245
213
  * 404 page config
246
214
  *
@@ -265,4 +233,12 @@ export interface DefaultThemeLocaleData extends LocaleData {
265
233
  * A11y text for sidebar toggle button
266
234
  */
267
235
  toggleSidebar?: string;
236
+ /**
237
+ * text for prev link
238
+ */
239
+ prev?: string | false;
240
+ /**
241
+ * text for next link
242
+ */
243
+ next?: string | false;
268
244
  }
@@ -1,12 +1,15 @@
1
1
  import type { GitPluginPageData } from '@vuepress/plugin-git';
2
- import type { NavLink, SidebarConfig } from './nav.js';
3
- export interface DefaultThemePageData extends GitPluginPageData {
2
+ import type { PageFrontmatter } from 'vuepress/shared';
3
+ import type { AutoLinkOptions } from './nav.js';
4
+ import type { SidebarArrayOptions } from './sidebar.js';
5
+ export interface DefaultThemePageData extends Partial<GitPluginPageData> {
4
6
  filePathRelative: string | null;
5
7
  }
6
- export interface DefaultThemePageFrontmatter {
8
+ export interface DefaultThemePageFrontmatter extends PageFrontmatter {
7
9
  home?: boolean;
8
10
  navbar?: boolean;
9
11
  pageClass?: string;
12
+ externalLinkIcon?: boolean;
10
13
  }
11
14
  export interface DefaultThemeHomePageFrontmatter extends DefaultThemePageFrontmatter {
12
15
  home: true;
@@ -34,8 +37,8 @@ export interface DefaultThemeNormalPageFrontmatter extends DefaultThemePageFront
34
37
  editLinkPattern?: string;
35
38
  lastUpdated?: boolean;
36
39
  contributors?: boolean;
37
- sidebar?: 'auto' | false | SidebarConfig;
40
+ sidebar?: SidebarArrayOptions | 'heading' | false;
38
41
  sidebarDepth?: number;
39
- prev?: string | NavLink;
40
- next?: string | NavLink;
42
+ prev?: AutoLinkOptions | string;
43
+ next?: AutoLinkOptions | string;
41
44
  }
@@ -0,0 +1,26 @@
1
+ import type { AutoLinkOptions, NavItemOptions } from './nav.js';
2
+ export type SidebarLinkOptions = AutoLinkOptions;
3
+ export interface SidebarGroupOptions extends NavItemOptions {
4
+ /**
5
+ * Link prefix of current group
6
+ */
7
+ prefix?: string;
8
+ /**
9
+ * Link of current group
10
+ */
11
+ link?: string;
12
+ /**
13
+ * Whether current group is collapsible
14
+ *
15
+ * @default false
16
+ */
17
+ collapsible?: boolean;
18
+ /**
19
+ * Children of current group
20
+ */
21
+ children: SidebarItemOptions[];
22
+ }
23
+ export type SidebarItemOptions = SidebarGroupOptions | SidebarLinkOptions | string;
24
+ export type SidebarArrayOptions = SidebarItemOptions[];
25
+ export type SidebarObjectOptions = Record<string, SidebarArrayOptions | 'heading' | false>;
26
+ export type SidebarOptions = SidebarArrayOptions | SidebarObjectOptions | 'heading';
@@ -0,0 +1 @@
1
+ export {};