@vuepress/theme-default 2.0.0-rc.10 → 2.0.0-rc.102
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.
- package/lib/client/components/VPAutoLink.vue +35 -0
- package/lib/client/components/VPDarkIcon.vue +8 -0
- package/lib/client/components/VPDropdownTransition.vue +43 -0
- package/lib/client/components/VPEditIcon.vue +12 -0
- package/lib/client/components/VPFadeSlideYTransition.vue +23 -0
- package/lib/client/components/VPHome.vue +37 -0
- package/lib/client/components/VPHomeFeatures.vue +65 -0
- package/lib/client/components/VPHomeFooter.vue +30 -0
- package/lib/client/components/VPHomeHero.vue +186 -0
- package/lib/client/components/VPLightIcon.vue +28 -0
- package/lib/client/components/VPNavbar.vue +138 -0
- package/lib/client/components/{NavbarBrand.vue → VPNavbarBrand.vue} +39 -15
- package/lib/client/components/VPNavbarDropdown.vue +330 -0
- package/lib/client/components/VPNavbarItems.vue +111 -0
- package/lib/client/components/VPPage.vue +69 -0
- package/lib/client/components/VPPageMeta.vue +139 -0
- package/lib/client/components/VPPageNav.vue +123 -0
- package/lib/client/components/VPSidebar.vue +120 -0
- package/lib/client/components/VPSidebarItem.vue +189 -0
- package/lib/client/components/{SidebarItems.vue → VPSidebarItems.vue} +27 -7
- package/lib/client/components/VPToggleColorModeButton.vue +55 -0
- package/lib/client/components/VPToggleSidebarButton.vue +92 -0
- package/lib/client/components/global/Badge.vue +84 -18
- package/lib/client/components/global/index.d.ts +1 -3
- package/lib/client/components/global/index.js +1 -3
- package/lib/client/composables/index.d.ts +7 -1
- package/lib/client/composables/index.js +7 -1
- package/lib/client/composables/useDarkMode.d.ts +0 -1
- package/lib/client/composables/useDarkMode.js +19 -16
- package/lib/client/composables/useData.d.ts +8 -0
- package/lib/client/composables/useData.js +7 -0
- package/lib/client/composables/useEditLink.d.ts +3 -0
- package/lib/client/composables/useEditLink.js +28 -0
- package/lib/client/composables/useHeaders.d.ts +9 -0
- package/lib/client/composables/useHeaders.js +38 -0
- package/lib/client/composables/useNavbarConfig.d.ts +3 -0
- package/lib/client/composables/useNavbarConfig.js +29 -0
- package/lib/client/composables/useNavbarRepo.d.ts +6 -0
- package/lib/client/composables/useNavbarRepo.js +38 -0
- package/lib/client/composables/useNavbarSelectLanguage.d.ts +6 -0
- package/lib/client/composables/useNavbarSelectLanguage.js +55 -0
- package/lib/client/composables/useNavigate.d.ts +1 -0
- package/lib/client/composables/useNavigate.js +22 -0
- package/lib/client/composables/useRelatedLinks.d.ts +8 -0
- package/lib/client/composables/useRelatedLinks.js +90 -0
- package/lib/client/composables/useScrollPromise.js +3 -1
- package/lib/client/composables/useSidebarItems.d.ts +21 -20
- package/lib/client/composables/useSidebarItems.js +96 -85
- package/lib/client/composables/useUpdateDeviceStatus.d.ts +1 -1
- package/lib/client/composables/useUpdateDeviceStatus.js +10 -5
- package/lib/client/config.d.ts +3 -2
- package/lib/client/config.js +8 -23
- package/lib/client/index.d.ts +1 -0
- package/lib/client/layouts/Layout.vue +126 -56
- package/lib/client/layouts/NotFound.vue +24 -10
- package/lib/client/shim.d.ts +6 -5
- package/lib/client/styles/_mixins.scss +4 -4
- package/lib/client/styles/_variables.module.scss +1 -1
- package/lib/client/styles/_variables.scss +2 -1
- package/lib/client/styles/arrow.scss +24 -22
- package/lib/client/styles/code-group.scss +34 -30
- package/lib/client/styles/content/code.scss +23 -0
- package/lib/client/styles/content/index.scss +3 -0
- package/lib/client/styles/content/normalize.scss +39 -0
- package/lib/client/styles/{toc.scss → content/toc.scss} +1 -1
- package/lib/client/styles/external-link-icon.scss +36 -0
- package/lib/client/styles/index.scss +3 -13
- package/lib/client/styles/layout.scss +5 -197
- package/lib/client/styles/normalize.scss +1 -194
- package/lib/client/styles/plugins.scss +28 -0
- package/lib/client/styles/vars-dark.scss +20 -58
- package/lib/client/styles/vars.scss +54 -139
- package/lib/client/typings.d.ts +13 -0
- package/lib/client/typings.js +1 -0
- package/lib/client/utils/index.d.ts +2 -1
- package/lib/client/utils/index.js +2 -1
- package/lib/client/utils/isActiveSidebarItem.d.ts +3 -3
- package/lib/client/utils/isActiveSidebarItem.js +1 -1
- package/lib/client/utils/resolveAutoLink.d.ts +9 -0
- package/lib/client/utils/{getNavLink.js → resolveAutoLink.js} +3 -3
- package/lib/client/utils/resolveEditLink.d.ts +3 -3
- package/lib/client/utils/resolveEditLink.js +3 -3
- package/lib/client/utils/resolvePrefix.d.ts +1 -0
- package/lib/client/utils/resolvePrefix.js +4 -0
- package/lib/client/utils/resolveRepoType.d.ts +1 -1
- package/lib/client/utils/resolveRepoType.js +4 -4
- package/lib/node/defaultTheme.d.ts +2 -1
- package/lib/node/defaultTheme.js +57 -64
- package/lib/node/index.d.ts +1 -3
- package/lib/node/index.js +0 -3
- package/lib/node/typings.d.ts +59 -0
- package/lib/node/typings.js +1 -0
- package/lib/node/utils/assignDefaultLocaleOptions.js +3 -8
- package/lib/node/utils/index.d.ts +1 -1
- package/lib/node/utils/index.js +1 -1
- package/lib/node/utils/resolveMarkdownHintLocales.d.ts +9 -0
- package/lib/node/utils/resolveMarkdownHintLocales.js +19 -0
- package/lib/shared/index.d.ts +5 -3
- package/lib/shared/index.js +1 -3
- package/lib/shared/nav.d.ts +19 -30
- package/lib/shared/navbar.d.ts +21 -0
- package/lib/shared/navbar.js +1 -0
- package/lib/shared/options.d.ts +36 -66
- package/lib/shared/page.d.ts +9 -6
- package/lib/shared/sidebar.d.ts +26 -0
- package/lib/shared/sidebar.js +1 -0
- package/package.json +34 -27
- package/templates/build.html +16 -10
- package/lib/client/components/AutoLink.vue +0 -113
- package/lib/client/components/DropdownTransition.vue +0 -25
- package/lib/client/components/Home.vue +0 -15
- package/lib/client/components/HomeContent.vue +0 -5
- package/lib/client/components/HomeFeatures.vue +0 -22
- package/lib/client/components/HomeFooter.vue +0 -17
- package/lib/client/components/HomeHero.vue +0 -97
- package/lib/client/components/Navbar.vue +0 -79
- package/lib/client/components/NavbarDropdown.vue +0 -126
- package/lib/client/components/NavbarItems.vue +0 -194
- package/lib/client/components/Page.vue +0 -31
- package/lib/client/components/PageMeta.vue +0 -124
- package/lib/client/components/PageNav.vue +0 -122
- package/lib/client/components/Sidebar.vue +0 -18
- package/lib/client/components/SidebarItem.vue +0 -87
- package/lib/client/components/ToggleColorModeButton.vue +0 -57
- package/lib/client/components/ToggleSidebarButton.vue +0 -24
- package/lib/client/components/global/CodeGroup.d.ts +0 -6
- package/lib/client/components/global/CodeGroup.js +0 -120
- package/lib/client/components/global/CodeGroupItem.vue +0 -27
- package/lib/client/composables/useThemeData.d.ts +0 -4
- package/lib/client/composables/useThemeData.js +0 -3
- package/lib/client/styles/badge.scss +0 -36
- package/lib/client/styles/code.scss +0 -263
- package/lib/client/styles/custom-container.scss +0 -142
- package/lib/client/styles/home.scss +0 -168
- package/lib/client/styles/navbar-dropdown.scss +0 -183
- package/lib/client/styles/navbar.scss +0 -197
- package/lib/client/styles/page.scss +0 -87
- package/lib/client/styles/sidebar.scss +0 -134
- package/lib/client/styles/transitions.scss +0 -22
- package/lib/client/utils/getNavLink.d.ts +0 -9
- package/lib/node/utils/resolveContainerPluginOptions.d.ts +0 -8
- package/lib/node/utils/resolveContainerPluginOptions.js +0 -17
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Theme } from 'vuepress/core';
|
|
2
|
-
import type { DefaultThemeLocaleOptions
|
|
2
|
+
import type { DefaultThemeLocaleOptions } from '../shared/index.js';
|
|
3
|
+
import type { DefaultThemePluginsOptions } from './typings.js';
|
|
3
4
|
export interface DefaultThemeOptions extends DefaultThemeLocaleOptions {
|
|
4
5
|
/**
|
|
5
6
|
* deployed hostname
|
package/lib/node/defaultTheme.js
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
import { addViteOptimizeDepsExclude } 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
4
|
import { copyCodePlugin } from '@vuepress/plugin-copy-code';
|
|
5
|
-
import { externalLinkIconPlugin } from '@vuepress/plugin-external-link-icon';
|
|
6
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';
|
|
7
9
|
import { mediumZoomPlugin } from '@vuepress/plugin-medium-zoom';
|
|
8
10
|
import { nprogressPlugin } from '@vuepress/plugin-nprogress';
|
|
9
11
|
import { palettePlugin } from '@vuepress/plugin-palette';
|
|
@@ -13,8 +15,8 @@ import { sitemapPlugin } from '@vuepress/plugin-sitemap';
|
|
|
13
15
|
import { themeDataPlugin } from '@vuepress/plugin-theme-data';
|
|
14
16
|
import { isPlainObject } from 'vuepress/shared';
|
|
15
17
|
import { fs, getDirname, path } from 'vuepress/utils';
|
|
16
|
-
import { assignDefaultLocaleOptions,
|
|
17
|
-
const __dirname = getDirname(import.meta.url);
|
|
18
|
+
import { assignDefaultLocaleOptions, resolveMarkdownHintLocales, } from './utils/index.js';
|
|
19
|
+
const __dirname = import.meta.dirname || getDirname(import.meta.url);
|
|
18
20
|
export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } = {}) => {
|
|
19
21
|
assignDefaultLocaleOptions(localeOptions);
|
|
20
22
|
return {
|
|
@@ -29,8 +31,28 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
|
|
|
29
31
|
`@theme/${file}`,
|
|
30
32
|
path.resolve(__dirname, '../client/components', file),
|
|
31
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
|
+
])),
|
|
42
|
+
// use alias to make all utils replaceable
|
|
43
|
+
...Object.fromEntries(fs
|
|
44
|
+
.readdirSync(path.resolve(__dirname, '../client/utils'))
|
|
45
|
+
.filter((file) => file.endsWith('.js'))
|
|
46
|
+
.map((file) => [
|
|
47
|
+
`@theme/${file.substring(0, file.length - 3)}`,
|
|
48
|
+
path.resolve(__dirname, '../client/utils', file),
|
|
49
|
+
])),
|
|
32
50
|
},
|
|
33
51
|
clientConfigFile: path.resolve(__dirname, '../client/config.js'),
|
|
52
|
+
extendsBundlerOptions: (bundlerOptions, app) => {
|
|
53
|
+
// ensure theme alias is not optimized by Vite
|
|
54
|
+
addViteOptimizeDepsExclude(bundlerOptions, app, '@theme');
|
|
55
|
+
},
|
|
34
56
|
extendsPage: (page) => {
|
|
35
57
|
// save relative file path into page data to generate edit link
|
|
36
58
|
page.data.filePathRelative = page.filePathRelative;
|
|
@@ -39,100 +61,65 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
|
|
|
39
61
|
},
|
|
40
62
|
plugins: [
|
|
41
63
|
// @vuepress/plugin-active-header-link
|
|
42
|
-
themePlugins.activeHeaderLinks
|
|
64
|
+
(themePlugins.activeHeaderLinks ?? true)
|
|
43
65
|
? activeHeaderLinksPlugin({
|
|
44
|
-
headerLinkSelector: 'a.sidebar-item',
|
|
45
|
-
headerAnchorSelector: '.header-anchor',
|
|
46
66
|
// should greater than page transition duration
|
|
47
67
|
delay: 300,
|
|
48
68
|
})
|
|
49
69
|
: [],
|
|
50
70
|
// @vuepress/plugin-back-to-top
|
|
51
|
-
themePlugins.backToTop
|
|
71
|
+
(themePlugins.backToTop ?? true)
|
|
52
72
|
? backToTopPlugin(isPlainObject(themePlugins.backToTop) ? themePlugins.backToTop : {})
|
|
53
73
|
: [],
|
|
54
74
|
// @vuepress/plugin-copy-code
|
|
55
|
-
themePlugins.copyCode
|
|
75
|
+
(themePlugins.copyCode ?? true)
|
|
56
76
|
? copyCodePlugin({
|
|
57
77
|
...(isPlainObject(themePlugins.copyCode)
|
|
58
78
|
? themePlugins.copyCode
|
|
59
79
|
: {}),
|
|
60
80
|
})
|
|
61
81
|
: [],
|
|
62
|
-
// @vuepress/plugin-container
|
|
63
|
-
themePlugins.
|
|
64
|
-
?
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
? containerPlugin(resolveContainerPluginOptions(localeOptions, 'warning'))
|
|
68
|
-
: [],
|
|
69
|
-
themePlugins.container?.danger !== false
|
|
70
|
-
? containerPlugin(resolveContainerPluginOptions(localeOptions, 'danger'))
|
|
71
|
-
: [],
|
|
72
|
-
themePlugins.container?.details !== false
|
|
73
|
-
? containerPlugin({
|
|
74
|
-
type: 'details',
|
|
75
|
-
before: (info) => `<details class="custom-container details">${info ? `<summary>${info}</summary>` : ''}\n`,
|
|
76
|
-
after: () => '</details>\n',
|
|
77
|
-
})
|
|
78
|
-
: [],
|
|
79
|
-
themePlugins.container?.codeGroup !== false
|
|
80
|
-
? containerPlugin({
|
|
81
|
-
type: 'code-group',
|
|
82
|
-
before: () => `<CodeGroup>\n`,
|
|
83
|
-
after: () => '</CodeGroup>\n',
|
|
84
|
-
})
|
|
85
|
-
: [],
|
|
86
|
-
themePlugins.container?.codeGroupItem !== false
|
|
87
|
-
? containerPlugin({
|
|
88
|
-
type: 'code-group-item',
|
|
89
|
-
before: (info) => `<CodeGroupItem title="${info}">\n`,
|
|
90
|
-
after: () => '</CodeGroupItem>\n',
|
|
91
|
-
})
|
|
92
|
-
: [],
|
|
93
|
-
// @vuepress/plugin-external-link-icon
|
|
94
|
-
themePlugins.externalLinkIcon !== false
|
|
95
|
-
? externalLinkIconPlugin({
|
|
96
|
-
locales: Object.entries(localeOptions.locales || {}).reduce((result, [key, value]) => {
|
|
97
|
-
result[key] = {
|
|
98
|
-
openInNewWindow: value.openInNewWindow ?? localeOptions.openInNewWindow,
|
|
99
|
-
};
|
|
100
|
-
return result;
|
|
101
|
-
}, {}),
|
|
82
|
+
// @vuepress/plugin-markdown-container
|
|
83
|
+
(themePlugins.hint ?? true)
|
|
84
|
+
? markdownHintPlugin({
|
|
85
|
+
locales: resolveMarkdownHintLocales(localeOptions),
|
|
86
|
+
...(isPlainObject(themePlugins.hint) ? themePlugins.hint : {}),
|
|
102
87
|
})
|
|
103
88
|
: [],
|
|
104
89
|
// @vuepress/plugin-git
|
|
105
|
-
themePlugins.git
|
|
90
|
+
(themePlugins.git ?? true)
|
|
106
91
|
? gitPlugin({
|
|
107
92
|
createdTime: false,
|
|
108
|
-
updatedTime: localeOptions.lastUpdated
|
|
109
|
-
|
|
93
|
+
updatedTime: localeOptions.lastUpdated ?? true,
|
|
94
|
+
changelog: { repoUrl: localeOptions.repo || '' },
|
|
95
|
+
...(isPlainObject(themePlugins.git) ? themePlugins.git : {}),
|
|
110
96
|
})
|
|
111
97
|
: [],
|
|
112
|
-
// @vuepress/plugin-
|
|
113
|
-
themePlugins.
|
|
114
|
-
?
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
// should greater than page transition duration
|
|
118
|
-
delay: 300,
|
|
119
|
-
})
|
|
98
|
+
// @vuepress/plugin-links-check
|
|
99
|
+
(themePlugins.linksCheck ?? true)
|
|
100
|
+
? linksCheckPlugin(isPlainObject(themePlugins.linksCheck)
|
|
101
|
+
? themePlugins.linksCheck
|
|
102
|
+
: {})
|
|
120
103
|
: [],
|
|
104
|
+
// @vuepress/plugin-medium-zoom
|
|
105
|
+
(themePlugins.mediumZoom ?? true) ? mediumZoomPlugin() : [],
|
|
121
106
|
// @vuepress/plugin-nprogress
|
|
122
|
-
themePlugins.nprogress
|
|
107
|
+
(themePlugins.nprogress ?? true) ? nprogressPlugin() : [],
|
|
123
108
|
// @vuepress/plugin-palette
|
|
124
109
|
palettePlugin({ preset: 'sass' }),
|
|
125
110
|
// @vuepress/plugin-prismjs
|
|
126
|
-
themePlugins.prismjs
|
|
111
|
+
(themePlugins.prismjs ?? true)
|
|
112
|
+
? prismjsPlugin(isPlainObject(themePlugins.prismjs) ? themePlugins.prismjs : {})
|
|
113
|
+
: [],
|
|
127
114
|
// @vuepress/plugin-seo
|
|
128
|
-
hostname && themePlugins.seo
|
|
115
|
+
hostname && (themePlugins.seo ?? true)
|
|
129
116
|
? seoPlugin({
|
|
130
117
|
hostname,
|
|
131
118
|
...(isPlainObject(themePlugins.seo) ? themePlugins.seo : {}),
|
|
132
119
|
})
|
|
133
120
|
: [],
|
|
134
121
|
// @vuepress/plugin-sitemap
|
|
135
|
-
hostname && themePlugins.sitemap
|
|
122
|
+
hostname && (themePlugins.sitemap ?? true)
|
|
136
123
|
? sitemapPlugin({
|
|
137
124
|
hostname,
|
|
138
125
|
...(isPlainObject(themePlugins.sitemap)
|
|
@@ -140,6 +127,12 @@ export const defaultTheme = ({ hostname, themePlugins = {}, ...localeOptions } =
|
|
|
140
127
|
: {}),
|
|
141
128
|
})
|
|
142
129
|
: [],
|
|
130
|
+
// @vuepress/plugin-markdown-tab
|
|
131
|
+
(themePlugins.tab ?? true)
|
|
132
|
+
? markdownTabPlugin(isPlainObject(themePlugins.tab)
|
|
133
|
+
? themePlugins.tab
|
|
134
|
+
: { codeTabs: true, tabs: true })
|
|
135
|
+
: [],
|
|
143
136
|
// @vuepress/plugin-theme-data
|
|
144
137
|
themeDataPlugin({ themeData: localeOptions }),
|
|
145
138
|
],
|
package/lib/node/index.d.ts
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
|
-
import { defaultTheme } from './defaultTheme.js';
|
|
2
1
|
export * from './defaultTheme.js';
|
|
2
|
+
export type * from './typings.js';
|
|
3
3
|
export * from './utils/index.js';
|
|
4
4
|
export type * from '../shared/index.js';
|
|
5
|
-
/** @deprecated Use named export instead */
|
|
6
|
-
export default defaultTheme;
|
package/lib/node/index.js
CHANGED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import type { BackToTopPluginOptions } from '@vuepress/plugin-back-to-top';
|
|
2
|
+
import type { CopyCodePluginOptions } from '@vuepress/plugin-copy-code';
|
|
3
|
+
import type { GitPluginOptions } from '@vuepress/plugin-git';
|
|
4
|
+
import type { LinksCheckPluginOptions } from '@vuepress/plugin-links-check';
|
|
5
|
+
import type { MarkdownHintPluginOptions } from '@vuepress/plugin-markdown-hint';
|
|
6
|
+
import type { MarkdownTabPluginOptions } from '@vuepress/plugin-markdown-tab';
|
|
7
|
+
import type { PrismjsPluginOptions } from '@vuepress/plugin-prismjs';
|
|
8
|
+
import type { SeoPluginOptions } from '@vuepress/plugin-seo';
|
|
9
|
+
import type { SitemapPluginOptions } from '@vuepress/plugin-sitemap';
|
|
10
|
+
export interface DefaultThemePluginsOptions {
|
|
11
|
+
/**
|
|
12
|
+
* Enable @vuepress/plugin-active-header-links or not
|
|
13
|
+
*/
|
|
14
|
+
activeHeaderLinks?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* Enable @vuepress/plugin-back-to-top or not
|
|
17
|
+
*/
|
|
18
|
+
backToTop?: BackToTopPluginOptions | boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Enable @vuepress/plugin-copy-code or not
|
|
21
|
+
*/
|
|
22
|
+
copyCode?: CopyCodePluginOptions | boolean;
|
|
23
|
+
/**
|
|
24
|
+
* Enable @vuepress/plugin-git or not
|
|
25
|
+
*/
|
|
26
|
+
git?: GitPluginOptions | boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Enable @vuepress/plugin-markdown-hint or not
|
|
29
|
+
*/
|
|
30
|
+
hint?: MarkdownHintPluginOptions | boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Enable @vuepress/plugin-links-check or not
|
|
33
|
+
*/
|
|
34
|
+
linksCheck?: LinksCheckPluginOptions | boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Enable @vuepress/plugin-medium-zoom or not
|
|
37
|
+
*/
|
|
38
|
+
mediumZoom?: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Enable @vuepress/plugin-nprogress or not
|
|
41
|
+
*/
|
|
42
|
+
nprogress?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Enable @vuepress/plugin-prismjs or not
|
|
45
|
+
*/
|
|
46
|
+
prismjs?: PrismjsPluginOptions | boolean;
|
|
47
|
+
/**
|
|
48
|
+
* Enable @vuepress/plugin-seo or not
|
|
49
|
+
*/
|
|
50
|
+
seo?: Partial<SeoPluginOptions> | boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Enable @vuepress/plugin-sitemap or not
|
|
53
|
+
*/
|
|
54
|
+
sitemap?: Partial<SitemapPluginOptions> | boolean;
|
|
55
|
+
/**
|
|
56
|
+
* Enable @vuepress/plugin-markdown-tab or not
|
|
57
|
+
*/
|
|
58
|
+
tab?: MarkdownTabPluginOptions | boolean;
|
|
59
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -9,13 +9,12 @@ export const DEFAULT_LOCALE_OPTIONS = {
|
|
|
9
9
|
selectLanguageText: 'Languages',
|
|
10
10
|
selectLanguageAriaLabel: 'Select language',
|
|
11
11
|
// sidebar
|
|
12
|
-
sidebar: '
|
|
12
|
+
sidebar: 'heading',
|
|
13
13
|
sidebarDepth: 2,
|
|
14
14
|
// page meta
|
|
15
15
|
editLink: true,
|
|
16
16
|
editLinkText: 'Edit this page',
|
|
17
17
|
lastUpdated: true,
|
|
18
|
-
lastUpdatedText: 'Last Updated',
|
|
19
18
|
contributors: true,
|
|
20
19
|
contributorsText: 'Contributors',
|
|
21
20
|
// 404 page messages
|
|
@@ -39,16 +38,12 @@ export const DEFAULT_LOCALE_DATA = {
|
|
|
39
38
|
* Assign default options
|
|
40
39
|
*/
|
|
41
40
|
export const assignDefaultLocaleOptions = (localeOptions) => {
|
|
42
|
-
|
|
43
|
-
localeOptions.locales = {};
|
|
44
|
-
}
|
|
45
|
-
if (!localeOptions.locales['/']) {
|
|
46
|
-
localeOptions.locales['/'] = {};
|
|
47
|
-
}
|
|
41
|
+
localeOptions.locales ??= {};
|
|
48
42
|
Object.assign(localeOptions, {
|
|
49
43
|
...DEFAULT_LOCALE_OPTIONS,
|
|
50
44
|
...localeOptions,
|
|
51
45
|
});
|
|
46
|
+
localeOptions.locales['/'] ??= {};
|
|
52
47
|
Object.assign(localeOptions.locales['/'], {
|
|
53
48
|
...DEFAULT_LOCALE_DATA,
|
|
54
49
|
...localeOptions.locales['/'],
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export * from './assignDefaultLocaleOptions.js';
|
|
2
|
-
export * from './
|
|
2
|
+
export * from './resolveMarkdownHintLocales.js';
|
package/lib/node/utils/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export * from './assignDefaultLocaleOptions.js';
|
|
2
|
-
export * from './
|
|
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
|
+
}, {});
|
package/lib/shared/index.d.ts
CHANGED
package/lib/shared/index.js
CHANGED
package/lib/shared/nav.d.ts
CHANGED
|
@@ -1,43 +1,32 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Base nav item, displayed as text
|
|
3
3
|
*/
|
|
4
|
-
export interface
|
|
4
|
+
export interface NavItemOptions {
|
|
5
5
|
text: string;
|
|
6
6
|
ariaLabel?: string;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Options for `<AutoLink>`
|
|
10
10
|
*/
|
|
11
|
-
export interface
|
|
12
|
-
|
|
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 {};
|
package/lib/shared/options.d.ts
CHANGED
|
@@ -1,63 +1,7 @@
|
|
|
1
|
-
import type { BackToTopPluginOptions } from '@vuepress/plugin-back-to-top';
|
|
2
|
-
import type { CopyCodePluginOptions } from '@vuepress/plugin-copy-code';
|
|
3
|
-
import type { SeoPluginOptions } from '@vuepress/plugin-seo';
|
|
4
|
-
import type { SitemapPluginOptions } from '@vuepress/plugin-sitemap';
|
|
5
1
|
import type { ThemeData } from '@vuepress/plugin-theme-data';
|
|
6
2
|
import type { LocaleData } from 'vuepress/shared';
|
|
7
|
-
import type {
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Enable @vuepress/plugin-active-header-links or not
|
|
11
|
-
*/
|
|
12
|
-
activeHeaderLinks?: boolean;
|
|
13
|
-
/**
|
|
14
|
-
* Enable @vuepress/plugin-back-to-top or not
|
|
15
|
-
*/
|
|
16
|
-
backToTop?: BackToTopPluginOptions | boolean;
|
|
17
|
-
/**
|
|
18
|
-
* Enable @vuepress/plugin-container or not
|
|
19
|
-
*/
|
|
20
|
-
container?: {
|
|
21
|
-
tip?: boolean;
|
|
22
|
-
warning?: boolean;
|
|
23
|
-
danger?: boolean;
|
|
24
|
-
details?: boolean;
|
|
25
|
-
codeGroup?: boolean;
|
|
26
|
-
codeGroupItem?: boolean;
|
|
27
|
-
};
|
|
28
|
-
/**
|
|
29
|
-
* Enable @vuepress/plugin-copy-code or not
|
|
30
|
-
*/
|
|
31
|
-
copyCode?: CopyCodePluginOptions | boolean;
|
|
32
|
-
/**
|
|
33
|
-
* Enable @vuepress/plugin-external-link-icon or not
|
|
34
|
-
*/
|
|
35
|
-
externalLinkIcon?: boolean;
|
|
36
|
-
/**
|
|
37
|
-
* Enable @vuepress/plugin-git or not
|
|
38
|
-
*/
|
|
39
|
-
git?: boolean;
|
|
40
|
-
/**
|
|
41
|
-
* Enable @vuepress/plugin-medium-zoom or not
|
|
42
|
-
*/
|
|
43
|
-
mediumZoom?: boolean;
|
|
44
|
-
/**
|
|
45
|
-
* Enable @vuepress/plugin-nprogress or not
|
|
46
|
-
*/
|
|
47
|
-
nprogress?: boolean;
|
|
48
|
-
/**
|
|
49
|
-
* Enable @vuepress/plugin-prismjs or not
|
|
50
|
-
*/
|
|
51
|
-
prismjs?: boolean;
|
|
52
|
-
/**
|
|
53
|
-
* Enable @vuepress/plugin-seo or not
|
|
54
|
-
*/
|
|
55
|
-
seo?: Partial<SeoPluginOptions> | boolean;
|
|
56
|
-
/**
|
|
57
|
-
* Enable @vuepress/plugin-sitemap or not
|
|
58
|
-
*/
|
|
59
|
-
sitemap?: Partial<SitemapPluginOptions> | boolean;
|
|
60
|
-
}
|
|
3
|
+
import type { NavbarOptions } from './navbar.js';
|
|
4
|
+
import type { SidebarOptions } from './sidebar.js';
|
|
61
5
|
export type DefaultThemeLocaleOptions = DefaultThemeData;
|
|
62
6
|
export type DefaultThemeData = ThemeData<DefaultThemeLocaleData>;
|
|
63
7
|
export interface DefaultThemeLocaleData extends LocaleData {
|
|
@@ -73,6 +17,12 @@ export interface DefaultThemeLocaleData extends LocaleData {
|
|
|
73
17
|
* @default true
|
|
74
18
|
*/
|
|
75
19
|
colorModeSwitch?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Whether show external link icon
|
|
22
|
+
*
|
|
23
|
+
* @default true
|
|
24
|
+
*/
|
|
25
|
+
externalLinkIcon?: boolean;
|
|
76
26
|
/**
|
|
77
27
|
* Home path of current locale
|
|
78
28
|
*
|
|
@@ -84,40 +34,40 @@ export interface DefaultThemeLocaleData extends LocaleData {
|
|
|
84
34
|
*
|
|
85
35
|
* Set to `false` to disable navbar in current locale
|
|
86
36
|
*/
|
|
87
|
-
navbar?:
|
|
37
|
+
navbar?: NavbarOptions | false;
|
|
88
38
|
/**
|
|
89
39
|
* Navbar label used for screen readers using the `aria-label` attribute
|
|
90
40
|
*/
|
|
91
|
-
navbarLabel?:
|
|
41
|
+
navbarLabel?: string | null;
|
|
92
42
|
/**
|
|
93
43
|
* Page navbar label used for screen readers using the `aria-label` attribute
|
|
94
44
|
*/
|
|
95
|
-
pageNavbarLabel?:
|
|
45
|
+
pageNavbarLabel?: string | null;
|
|
96
46
|
/**
|
|
97
47
|
* Navbar logo config
|
|
98
48
|
*
|
|
99
49
|
* Logo to display in navbar
|
|
100
50
|
*/
|
|
101
|
-
logo?:
|
|
51
|
+
logo?: string | null;
|
|
102
52
|
/**
|
|
103
53
|
* Navbar logo config for dark mode
|
|
104
54
|
*
|
|
105
55
|
* Logo to display in navbar in dark mode
|
|
106
56
|
*/
|
|
107
|
-
logoDark?:
|
|
57
|
+
logoDark?: string | null;
|
|
108
58
|
/**
|
|
109
59
|
* The alt text of navbar logo.
|
|
110
60
|
* Defaults to the site title if not specified.
|
|
111
61
|
* If the value is the same as the site title, the site title rendered in the navbar will be
|
|
112
62
|
* hidden from screen readers to avoid duplication.
|
|
113
63
|
*/
|
|
114
|
-
logoAlt?:
|
|
64
|
+
logoAlt?: string | null;
|
|
115
65
|
/**
|
|
116
66
|
* Navbar repository config
|
|
117
67
|
*
|
|
118
68
|
* Used for the repository link of navbar
|
|
119
69
|
*/
|
|
120
|
-
repo?:
|
|
70
|
+
repo?: string | null;
|
|
121
71
|
/**
|
|
122
72
|
* Navbar repository config
|
|
123
73
|
*
|
|
@@ -149,7 +99,7 @@ export interface DefaultThemeLocaleData extends LocaleData {
|
|
|
149
99
|
*
|
|
150
100
|
* Set to `false` to disable sidebar in current locale
|
|
151
101
|
*/
|
|
152
|
-
sidebar?:
|
|
102
|
+
sidebar?: SidebarOptions | false;
|
|
153
103
|
/**
|
|
154
104
|
* Sidebar depth
|
|
155
105
|
*
|
|
@@ -247,6 +197,18 @@ export interface DefaultThemeLocaleData extends LocaleData {
|
|
|
247
197
|
* Default title of DANGER custom block
|
|
248
198
|
*/
|
|
249
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;
|
|
250
212
|
/**
|
|
251
213
|
* 404 page config
|
|
252
214
|
*
|
|
@@ -271,4 +233,12 @@ export interface DefaultThemeLocaleData extends LocaleData {
|
|
|
271
233
|
* A11y text for sidebar toggle button
|
|
272
234
|
*/
|
|
273
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;
|
|
274
244
|
}
|
package/lib/shared/page.d.ts
CHANGED
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import type { GitPluginPageData } from '@vuepress/plugin-git';
|
|
2
|
-
import type {
|
|
3
|
-
|
|
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?: '
|
|
40
|
+
sidebar?: SidebarArrayOptions | 'heading' | false;
|
|
38
41
|
sidebarDepth?: number;
|
|
39
|
-
prev?:
|
|
40
|
-
next?:
|
|
42
|
+
prev?: AutoLinkOptions | string;
|
|
43
|
+
next?: AutoLinkOptions | string;
|
|
41
44
|
}
|