@vuepress/theme-default 2.0.0-beta.6 → 2.0.0-beta.61
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/AutoLink.vue +114 -0
- package/lib/client/components/DropdownTransition.vue +21 -0
- package/lib/client/components/Home.vue +15 -0
- package/lib/client/components/HomeContent.vue +5 -0
- package/lib/client/components/HomeFeatures.vue +23 -0
- package/lib/client/components/HomeFooter.vue +17 -0
- package/lib/client/components/HomeHero.vue +98 -0
- package/lib/client/components/Navbar.vue +75 -0
- package/lib/client/components/NavbarBrand.vue +55 -0
- package/lib/client/components/NavbarDropdown.vue +126 -0
- package/lib/{components/NavbarLinks.vue → client/components/NavbarItems.vue} +61 -50
- package/lib/{components → client/components}/Page.vue +9 -15
- package/lib/{components → client/components}/PageMeta.vue +51 -66
- package/lib/{components → client/components}/PageNav.vue +44 -57
- package/lib/client/components/Sidebar.vue +13 -0
- package/lib/client/components/SidebarItem.vue +87 -0
- package/lib/client/components/SidebarItems.vue +57 -0
- package/lib/client/components/ToggleColorModeButton.vue +57 -0
- package/lib/client/components/ToggleSidebarButton.vue +24 -0
- package/lib/client/components/global/Badge.vue +31 -0
- package/lib/client/components/global/CodeGroup.d.ts +4 -0
- package/lib/client/components/global/CodeGroup.js +106 -0
- package/lib/client/components/global/CodeGroupItem.vue +31 -0
- package/lib/client/components/global/index.d.ts +4 -0
- package/lib/client/components/global/index.js +4 -0
- package/lib/client/composables/index.d.ts +6 -0
- package/lib/client/composables/index.js +6 -0
- package/lib/client/composables/useDarkMode.d.ts +12 -0
- package/lib/client/composables/useDarkMode.js +57 -0
- package/lib/{composables → client/composables}/useNavLink.d.ts +6 -1
- package/lib/{composables → client/composables}/useNavLink.js +5 -2
- package/lib/{composables → client/composables}/useResolveRouteWithRedirect.d.ts +1 -1
- package/lib/{composables → client/composables}/useResolveRouteWithRedirect.js +2 -2
- package/lib/{composables → client/composables}/useScrollPromise.js +1 -1
- package/lib/client/composables/useSidebarItems.d.ts +36 -0
- package/lib/client/composables/useSidebarItems.js +118 -0
- package/lib/{composables → client/composables}/useThemeData.d.ts +2 -2
- package/lib/{composables → client/composables}/useThemeData.js +1 -1
- package/lib/client/config.d.ts +3 -0
- package/lib/client/config.js +44 -0
- package/lib/client/index.d.ts +3 -0
- package/lib/client/index.js +3 -0
- package/lib/client/layouts/Layout.vue +134 -0
- package/lib/client/layouts/NotFound.vue +27 -0
- package/lib/{styles/_wrapper.scss → client/styles/_mixins.scss} +7 -2
- package/lib/client/styles/_variables.scss +6 -0
- package/lib/{styles → client/styles}/arrow.scss +4 -6
- package/lib/client/styles/badge.scss +34 -0
- package/lib/{styles → client/styles}/code-group.scss +9 -2
- package/lib/{styles → client/styles}/code.scss +35 -49
- package/lib/client/styles/custom-container.scss +140 -0
- package/lib/{styles → client/styles}/home.scss +32 -24
- package/lib/{styles → client/styles}/index.scss +4 -4
- package/lib/client/styles/layout.scss +199 -0
- package/lib/{styles/dropdown.scss → client/styles/navbar-dropdown.scss} +36 -50
- package/lib/client/styles/navbar.scss +197 -0
- package/lib/client/styles/normalize.scss +200 -0
- package/lib/{styles → client/styles}/page.scss +24 -8
- package/lib/client/styles/sidebar.scss +134 -0
- package/lib/client/styles/transitions.scss +22 -0
- package/lib/client/styles/vars-dark.scss +68 -0
- package/lib/client/styles/vars.scss +149 -0
- package/lib/client/utils/index.d.ts +3 -0
- package/lib/client/utils/index.js +3 -0
- package/lib/client/utils/isActiveSidebarItem.d.ts +3 -0
- package/lib/client/utils/isActiveSidebarItem.js +20 -0
- package/lib/{utils → client/utils}/resolveEditLink.d.ts +2 -2
- package/lib/{utils → client/utils}/resolveEditLink.js +15 -9
- package/lib/client/utils/resolveRepoType.d.ts +2 -0
- package/lib/{utils → client/utils}/resolveRepoType.js +3 -1
- package/lib/node/defaultTheme.d.ts +10 -0
- package/lib/node/defaultTheme.js +117 -0
- package/lib/node/index.d.ts +5 -5
- package/lib/node/index.js +5 -17
- package/lib/node/utils/assignDefaultLocaleOptions.d.ts +7 -0
- package/lib/node/{assignDefaultLocaleOptions.js → utils/assignDefaultLocaleOptions.js} +13 -13
- package/lib/node/utils/index.d.ts +2 -0
- package/lib/node/utils/index.js +2 -0
- package/lib/node/utils/resolveContainerPluginOptions.d.ts +8 -0
- package/lib/node/utils/resolveContainerPluginOptions.js +17 -0
- package/lib/shared/index.d.ts +3 -0
- package/lib/shared/index.js +3 -0
- package/lib/shared/nav.d.ts +42 -0
- package/lib/shared/nav.js +1 -0
- package/lib/{types → shared}/options.d.ts +51 -13
- package/lib/shared/options.js +1 -0
- package/lib/{types → shared}/page.d.ts +15 -6
- package/lib/shared/page.js +1 -0
- package/package.json +49 -29
- package/templates/build.html +33 -0
- package/CHANGELOG.md +0 -376
- package/lib/clientAppEnhance.d.ts +0 -3
- package/lib/clientAppEnhance.js +0 -30
- package/lib/clientAppSetup.d.ts +0 -2
- package/lib/clientAppSetup.js +0 -11
- package/lib/components/DropdownLink.vue +0 -141
- package/lib/components/DropdownTransition.vue +0 -34
- package/lib/components/Home.vue +0 -133
- package/lib/components/NavLink.vue +0 -115
- package/lib/components/Navbar.vue +0 -114
- package/lib/components/Sidebar.vue +0 -38
- package/lib/components/SidebarChild.d.ts +0 -6
- package/lib/components/SidebarChild.js +0 -91
- package/lib/components/ToggleSidebarButton.vue +0 -27
- package/lib/components/global/Badge.vue +0 -37
- package/lib/components/global/CodeGroup.d.ts +0 -5
- package/lib/components/global/CodeGroup.js +0 -52
- package/lib/components/global/CodeGroupItem.vue +0 -25
- package/lib/components/global/OutboundLink.vue +0 -30
- package/lib/composables/index.d.ts +0 -5
- package/lib/composables/index.js +0 -5
- package/lib/composables/useSidebarItems.d.ts +0 -31
- package/lib/composables/useSidebarItems.js +0 -114
- package/lib/index.d.ts +0 -6
- package/lib/index.js +0 -67
- package/lib/layouts/404.vue +0 -38
- package/lib/layouts/Layout.vue +0 -152
- package/lib/node/assignDefaultLocaleOptions.d.ts +0 -5
- package/lib/node/resolveActiveHeaderLinksPluginOptions.d.ts +0 -6
- package/lib/node/resolveActiveHeaderLinksPluginOptions.js +0 -16
- package/lib/node/resolveContainerPluginOptions.d.ts +0 -26
- package/lib/node/resolveContainerPluginOptions.js +0 -79
- package/lib/node/resolveGitPluginOptions.d.ts +0 -6
- package/lib/node/resolveGitPluginOptions.js +0 -22
- package/lib/node/resolveMediumZoomPluginOptions.d.ts +0 -6
- package/lib/node/resolveMediumZoomPluginOptions.js +0 -17
- package/lib/styles/_normalize.scss +0 -148
- package/lib/styles/_variables.scss +0 -34
- package/lib/styles/badge.scss +0 -33
- package/lib/styles/custom-container.scss +0 -78
- package/lib/styles/layout.scss +0 -194
- package/lib/styles/navbar.scss +0 -141
- package/lib/styles/plugins.scss +0 -18
- package/lib/styles/sidebar.scss +0 -152
- package/lib/styles/sr-only.scss +0 -12
- package/lib/styles/transitions.scss +0 -13
- package/lib/types/index.d.ts +0 -3
- package/lib/types/index.js +0 -15
- package/lib/types/nav.d.ts +0 -44
- package/lib/types/nav.js +0 -2
- package/lib/types/options.js +0 -2
- package/lib/types/page.js +0 -2
- package/lib/utils/index.d.ts +0 -2
- package/lib/utils/index.js +0 -2
- package/lib/utils/resolveRepoType.d.ts +0 -2
- /package/lib/{composables → client/composables}/useScrollPromise.d.ts +0 -0
- /package/lib/{shim.d.ts → client/shim.d.ts} +0 -0
- /package/lib/{styles → client/styles}/toc.scss +0 -0
|
@@ -1,28 +1,18 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
<template v-else>
|
|
9
|
-
<NavLink :item="item" />
|
|
10
|
-
</template>
|
|
11
|
-
</div>
|
|
12
|
-
</nav>
|
|
13
|
-
</template>
|
|
14
|
-
|
|
15
|
-
<script lang="ts">
|
|
16
|
-
import { computed, defineComponent } from 'vue'
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
+
import NavbarDropdown from '@theme/NavbarDropdown.vue'
|
|
4
|
+
import { useRouteLocale, useSiteLocaleData } from '@vuepress/client'
|
|
5
|
+
import { isLinkHttp, isString } from '@vuepress/shared'
|
|
6
|
+
import { computed, onMounted, ref } from 'vue'
|
|
17
7
|
import type { ComputedRef } from 'vue'
|
|
18
8
|
import { useRouter } from 'vue-router'
|
|
19
|
-
import {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
import
|
|
25
|
-
import
|
|
9
|
+
import type {
|
|
10
|
+
NavbarGroup,
|
|
11
|
+
NavbarItem,
|
|
12
|
+
ResolvedNavbarItem,
|
|
13
|
+
} from '../../shared/index.js'
|
|
14
|
+
import { useNavLink, useThemeLocaleData } from '../composables/index.js'
|
|
15
|
+
import { resolveRepoType } from '../utils/index.js'
|
|
26
16
|
|
|
27
17
|
/**
|
|
28
18
|
* Get navbar config of select language dropdown
|
|
@@ -43,10 +33,13 @@ const useNavbarSelectLanguage = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
|
43
33
|
const currentFullPath = router.currentRoute.value.fullPath
|
|
44
34
|
|
|
45
35
|
const languageDropdown: ResolvedNavbarItem = {
|
|
46
|
-
text: themeLocale.value.selectLanguageText ?? '
|
|
47
|
-
ariaLabel:
|
|
36
|
+
text: themeLocale.value.selectLanguageText ?? 'unknown language',
|
|
37
|
+
ariaLabel:
|
|
38
|
+
themeLocale.value.selectLanguageAriaLabel ??
|
|
39
|
+
themeLocale.value.selectLanguageText ??
|
|
40
|
+
'unknown language',
|
|
48
41
|
children: localePaths.map((targetLocalePath) => {
|
|
49
|
-
// target locale config of this
|
|
42
|
+
// target locale config of this language link
|
|
50
43
|
const targetSiteLocale =
|
|
51
44
|
siteLocale.value.locales?.[targetLocalePath] ?? {}
|
|
52
45
|
const targetThemeLocale =
|
|
@@ -71,7 +64,8 @@ const useNavbarSelectLanguage = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
|
71
64
|
if (
|
|
72
65
|
router.getRoutes().some((item) => item.path === targetLocalePage)
|
|
73
66
|
) {
|
|
74
|
-
|
|
67
|
+
// try to keep current hash and params across languages
|
|
68
|
+
link = currentFullPath.replace(currentPath, targetLocalePage)
|
|
75
69
|
} else {
|
|
76
70
|
link = targetThemeLocale.home ?? targetLocalePath
|
|
77
71
|
}
|
|
@@ -100,9 +94,10 @@ const useNavbarRepo = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
|
100
94
|
)
|
|
101
95
|
|
|
102
96
|
const repoLink = computed(() => {
|
|
103
|
-
if (
|
|
97
|
+
if (repo.value && !isLinkHttp(repo.value)) {
|
|
104
98
|
return `https://github.com/${repo.value}`
|
|
105
99
|
}
|
|
100
|
+
|
|
106
101
|
return repo.value
|
|
107
102
|
})
|
|
108
103
|
|
|
@@ -147,28 +142,44 @@ const useNavbarConfig = (): ComputedRef<ResolvedNavbarItem[]> => {
|
|
|
147
142
|
return computed(() => (themeLocale.value.navbar || []).map(resolveNavbarItem))
|
|
148
143
|
}
|
|
149
144
|
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
145
|
+
const isMobile = ref(false)
|
|
146
|
+
const navbarConfig = useNavbarConfig()
|
|
147
|
+
const navbarSelectLanguage = useNavbarSelectLanguage()
|
|
148
|
+
const navbarRepo = useNavbarRepo()
|
|
149
|
+
const navbarLinks = computed(() => [
|
|
150
|
+
...navbarConfig.value,
|
|
151
|
+
...navbarSelectLanguage.value,
|
|
152
|
+
...navbarRepo.value,
|
|
153
|
+
])
|
|
154
|
+
|
|
155
|
+
// avoid overlapping of long title and long navbar links
|
|
156
|
+
onMounted(() => {
|
|
157
|
+
// TODO: migrate to css var
|
|
158
|
+
// refer to _variables.scss
|
|
159
|
+
const MOBILE_DESKTOP_BREAKPOINT = 719
|
|
160
|
+
|
|
161
|
+
const handleMobile = (): void => {
|
|
162
|
+
if (window.innerWidth < MOBILE_DESKTOP_BREAKPOINT) {
|
|
163
|
+
isMobile.value = true
|
|
164
|
+
} else {
|
|
165
|
+
isMobile.value = false
|
|
171
166
|
}
|
|
172
|
-
}
|
|
167
|
+
}
|
|
168
|
+
handleMobile()
|
|
169
|
+
window.addEventListener('resize', handleMobile, false)
|
|
170
|
+
window.addEventListener('orientationchange', handleMobile, false)
|
|
173
171
|
})
|
|
174
172
|
</script>
|
|
173
|
+
|
|
174
|
+
<template>
|
|
175
|
+
<nav v-if="navbarLinks.length" class="navbar-items">
|
|
176
|
+
<div v-for="item in navbarLinks" :key="item.text" class="navbar-item">
|
|
177
|
+
<NavbarDropdown
|
|
178
|
+
v-if="item.children"
|
|
179
|
+
:item="item"
|
|
180
|
+
:class="isMobile ? 'mobile' : ''"
|
|
181
|
+
/>
|
|
182
|
+
<AutoLink v-else :item="item" />
|
|
183
|
+
</div>
|
|
184
|
+
</nav>
|
|
185
|
+
</template>
|
|
@@ -1,9 +1,18 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import PageMeta from '@theme/PageMeta.vue'
|
|
3
|
+
import PageNav from '@theme/PageNav.vue'
|
|
4
|
+
</script>
|
|
5
|
+
|
|
1
6
|
<template>
|
|
2
7
|
<main class="page">
|
|
3
8
|
<slot name="top" />
|
|
4
9
|
|
|
5
10
|
<div class="theme-default-content">
|
|
11
|
+
<slot name="content-top" />
|
|
12
|
+
|
|
6
13
|
<Content />
|
|
14
|
+
|
|
15
|
+
<slot name="content-bottom" />
|
|
7
16
|
</div>
|
|
8
17
|
|
|
9
18
|
<PageMeta />
|
|
@@ -13,18 +22,3 @@
|
|
|
13
22
|
<slot name="bottom" />
|
|
14
23
|
</main>
|
|
15
24
|
</template>
|
|
16
|
-
|
|
17
|
-
<script>
|
|
18
|
-
import { defineComponent } from 'vue'
|
|
19
|
-
import PageMeta from './PageMeta.vue'
|
|
20
|
-
import PageNav from './PageNav.vue'
|
|
21
|
-
|
|
22
|
-
export default defineComponent({
|
|
23
|
-
name: 'Page',
|
|
24
|
-
|
|
25
|
-
components: {
|
|
26
|
-
PageMeta,
|
|
27
|
-
PageNav,
|
|
28
|
-
},
|
|
29
|
-
})
|
|
30
|
-
</script>
|
|
@@ -1,48 +1,20 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
</div>
|
|
6
|
-
|
|
7
|
-
<div v-if="lastUpdated" class="meta-item last-updated">
|
|
8
|
-
<span class="meta-item-label">{{ themeLocale.lastUpdatedText }}: </span>
|
|
9
|
-
<span class="meta-item-info">{{ lastUpdated }}</span>
|
|
10
|
-
</div>
|
|
11
|
-
|
|
12
|
-
<div
|
|
13
|
-
v-if="contributors && contributors.length"
|
|
14
|
-
class="meta-item contributors"
|
|
15
|
-
>
|
|
16
|
-
<span class="meta-item-label">{{ themeLocale.contributorsText }}: </span>
|
|
17
|
-
<span class="meta-item-info">
|
|
18
|
-
<template v-for="(contributor, index) in contributors" :key="index">
|
|
19
|
-
<span class="contributor" :title="`email: ${contributor.email}`">
|
|
20
|
-
{{ contributor.name }}
|
|
21
|
-
</span>
|
|
22
|
-
<template v-if="index !== contributors.length - 1">, </template>
|
|
23
|
-
</template>
|
|
24
|
-
</span>
|
|
25
|
-
</div>
|
|
26
|
-
</footer>
|
|
27
|
-
</template>
|
|
28
|
-
|
|
29
|
-
<script lang="ts">
|
|
30
|
-
import { computed, defineComponent } from 'vue'
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
+
import { usePageData, usePageFrontmatter } from '@vuepress/client'
|
|
4
|
+
import { computed } from 'vue'
|
|
31
5
|
import type { ComputedRef } from 'vue'
|
|
32
|
-
import {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
} from '
|
|
37
|
-
import { useThemeLocaleData } from '../composables'
|
|
38
|
-
import
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
const useEditNavLink = (): ComputedRef<null | NavLinkType> => {
|
|
6
|
+
import type {
|
|
7
|
+
DefaultThemeNormalPageFrontmatter,
|
|
8
|
+
DefaultThemePageData,
|
|
9
|
+
NavLink,
|
|
10
|
+
} from '../../shared/index.js'
|
|
11
|
+
import { useThemeLocaleData } from '../composables/index.js'
|
|
12
|
+
import { resolveEditLink } from '../utils/index.js'
|
|
13
|
+
|
|
14
|
+
const useEditNavLink = (): ComputedRef<null | NavLink> => {
|
|
43
15
|
const themeLocale = useThemeLocaleData()
|
|
44
16
|
const page = usePageData<DefaultThemePageData>()
|
|
45
|
-
const frontmatter = usePageFrontmatter()
|
|
17
|
+
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
46
18
|
|
|
47
19
|
return computed(() => {
|
|
48
20
|
const showEditLink =
|
|
@@ -66,7 +38,8 @@ const useEditNavLink = (): ComputedRef<null | NavLinkType> => {
|
|
|
66
38
|
docsBranch,
|
|
67
39
|
docsDir,
|
|
68
40
|
filePathRelative: page.value.filePathRelative,
|
|
69
|
-
editLinkPattern:
|
|
41
|
+
editLinkPattern:
|
|
42
|
+
frontmatter.value.editLinkPattern ?? themeLocale.value.editLinkPattern,
|
|
70
43
|
})
|
|
71
44
|
|
|
72
45
|
if (!editLink) return null
|
|
@@ -79,10 +52,9 @@ const useEditNavLink = (): ComputedRef<null | NavLinkType> => {
|
|
|
79
52
|
}
|
|
80
53
|
|
|
81
54
|
const useLastUpdated = (): ComputedRef<null | string> => {
|
|
82
|
-
const siteLocale = useSiteLocaleData()
|
|
83
55
|
const themeLocale = useThemeLocaleData()
|
|
84
56
|
const page = usePageData<DefaultThemePageData>()
|
|
85
|
-
const frontmatter = usePageFrontmatter()
|
|
57
|
+
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
86
58
|
|
|
87
59
|
return computed(() => {
|
|
88
60
|
const showLastUpdated =
|
|
@@ -94,7 +66,7 @@ const useLastUpdated = (): ComputedRef<null | string> => {
|
|
|
94
66
|
|
|
95
67
|
const updatedDate = new Date(page.value.git?.updatedTime)
|
|
96
68
|
|
|
97
|
-
return updatedDate.toLocaleString(
|
|
69
|
+
return updatedDate.toLocaleString()
|
|
98
70
|
})
|
|
99
71
|
}
|
|
100
72
|
|
|
@@ -103,7 +75,7 @@ const useContributors = (): ComputedRef<
|
|
|
103
75
|
> => {
|
|
104
76
|
const themeLocale = useThemeLocaleData()
|
|
105
77
|
const page = usePageData<DefaultThemePageData>()
|
|
106
|
-
const frontmatter = usePageFrontmatter()
|
|
78
|
+
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
107
79
|
|
|
108
80
|
return computed(() => {
|
|
109
81
|
const showContributors =
|
|
@@ -115,25 +87,38 @@ const useContributors = (): ComputedRef<
|
|
|
115
87
|
})
|
|
116
88
|
}
|
|
117
89
|
|
|
118
|
-
|
|
119
|
-
|
|
90
|
+
const themeLocale = useThemeLocaleData()
|
|
91
|
+
const editNavLink = useEditNavLink()
|
|
92
|
+
const lastUpdated = useLastUpdated()
|
|
93
|
+
const contributors = useContributors()
|
|
94
|
+
</script>
|
|
120
95
|
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
96
|
+
<template>
|
|
97
|
+
<footer class="page-meta">
|
|
98
|
+
<div v-if="editNavLink" class="meta-item edit-link">
|
|
99
|
+
<AutoLink class="meta-item-label" :item="editNavLink" />
|
|
100
|
+
</div>
|
|
124
101
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
102
|
+
<div v-if="lastUpdated" class="meta-item last-updated">
|
|
103
|
+
<span class="meta-item-label">{{ themeLocale.lastUpdatedText }}: </span>
|
|
104
|
+
<ClientOnly>
|
|
105
|
+
<span class="meta-item-info">{{ lastUpdated }}</span>
|
|
106
|
+
</ClientOnly>
|
|
107
|
+
</div>
|
|
130
108
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
}
|
|
139
|
-
|
|
109
|
+
<div
|
|
110
|
+
v-if="contributors && contributors.length"
|
|
111
|
+
class="meta-item contributors"
|
|
112
|
+
>
|
|
113
|
+
<span class="meta-item-label">{{ themeLocale.contributorsText }}: </span>
|
|
114
|
+
<span class="meta-item-info">
|
|
115
|
+
<template v-for="(contributor, index) in contributors" :key="index">
|
|
116
|
+
<span class="contributor" :title="`email: ${contributor.email}`">
|
|
117
|
+
{{ contributor.name }}
|
|
118
|
+
</span>
|
|
119
|
+
<template v-if="index !== contributors.length - 1">, </template>
|
|
120
|
+
</template>
|
|
121
|
+
</span>
|
|
122
|
+
</div>
|
|
123
|
+
</footer>
|
|
124
|
+
</template>
|
|
@@ -1,34 +1,22 @@
|
|
|
1
|
-
<
|
|
2
|
-
|
|
3
|
-
<p class="inner">
|
|
4
|
-
<span v-if="prevNavLink" class="prev">
|
|
5
|
-
←
|
|
6
|
-
<NavLink :item="prevNavLink" />
|
|
7
|
-
</span>
|
|
8
|
-
|
|
9
|
-
<span v-if="nextNavLink" class="next">
|
|
10
|
-
<NavLink :item="nextNavLink" />
|
|
11
|
-
→
|
|
12
|
-
</span>
|
|
13
|
-
</p>
|
|
14
|
-
</nav>
|
|
15
|
-
</template>
|
|
16
|
-
|
|
17
|
-
<script lang="ts">
|
|
18
|
-
import { computed, defineComponent } from 'vue'
|
|
19
|
-
import { useRoute } from 'vue-router'
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import AutoLink from '@theme/AutoLink.vue'
|
|
20
3
|
import { usePageFrontmatter } from '@vuepress/client'
|
|
21
4
|
import { isPlainObject, isString } from '@vuepress/shared'
|
|
22
|
-
import {
|
|
23
|
-
import
|
|
24
|
-
import
|
|
5
|
+
import { computed } from 'vue'
|
|
6
|
+
import { useRoute } from 'vue-router'
|
|
7
|
+
import type {
|
|
8
|
+
DefaultThemeNormalPageFrontmatter,
|
|
9
|
+
NavLink,
|
|
10
|
+
ResolvedSidebarItem,
|
|
11
|
+
} from '../../shared/index.js'
|
|
12
|
+
import { useNavLink, useSidebarItems } from '../composables/index.js'
|
|
25
13
|
|
|
26
14
|
/**
|
|
27
15
|
* Resolve `prev` or `next` config from frontmatter
|
|
28
16
|
*/
|
|
29
17
|
const resolveFromFrontmatterConfig = (
|
|
30
18
|
conf: unknown
|
|
31
|
-
): null | false |
|
|
19
|
+
): null | false | NavLink => {
|
|
32
20
|
if (conf === false) {
|
|
33
21
|
return null
|
|
34
22
|
}
|
|
@@ -37,7 +25,7 @@ const resolveFromFrontmatterConfig = (
|
|
|
37
25
|
return useNavLink(conf)
|
|
38
26
|
}
|
|
39
27
|
|
|
40
|
-
if (isPlainObject<
|
|
28
|
+
if (isPlainObject<NavLink>(conf)) {
|
|
41
29
|
return conf
|
|
42
30
|
}
|
|
43
31
|
|
|
@@ -51,14 +39,14 @@ const resolveFromSidebarItems = (
|
|
|
51
39
|
sidebarItems: ResolvedSidebarItem[],
|
|
52
40
|
currentPath: string,
|
|
53
41
|
offset: number
|
|
54
|
-
): null |
|
|
42
|
+
): null | NavLink => {
|
|
55
43
|
const index = sidebarItems.findIndex((item) => item.link === currentPath)
|
|
56
44
|
if (index !== -1) {
|
|
57
45
|
const targetItem = sidebarItems[index + offset]
|
|
58
46
|
if (!targetItem?.link) {
|
|
59
47
|
return null
|
|
60
48
|
}
|
|
61
|
-
return targetItem as
|
|
49
|
+
return targetItem as NavLink
|
|
62
50
|
}
|
|
63
51
|
|
|
64
52
|
for (const item of sidebarItems) {
|
|
@@ -77,40 +65,39 @@ const resolveFromSidebarItems = (
|
|
|
77
65
|
return null
|
|
78
66
|
}
|
|
79
67
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
components: {
|
|
84
|
-
NavLink,
|
|
85
|
-
},
|
|
86
|
-
|
|
87
|
-
setup() {
|
|
88
|
-
const frontmatter = usePageFrontmatter()
|
|
89
|
-
const sidebarItems = useSidebarItems()
|
|
90
|
-
const route = useRoute()
|
|
91
|
-
|
|
92
|
-
const prevNavLink = computed(() => {
|
|
93
|
-
const prevConfig = resolveFromFrontmatterConfig(frontmatter.value.prev)
|
|
94
|
-
if (prevConfig !== false) {
|
|
95
|
-
return prevConfig
|
|
96
|
-
}
|
|
68
|
+
const frontmatter = usePageFrontmatter<DefaultThemeNormalPageFrontmatter>()
|
|
69
|
+
const sidebarItems = useSidebarItems()
|
|
70
|
+
const route = useRoute()
|
|
97
71
|
|
|
98
|
-
|
|
99
|
-
|
|
72
|
+
const prevNavLink = computed(() => {
|
|
73
|
+
const prevConfig = resolveFromFrontmatterConfig(frontmatter.value.prev)
|
|
74
|
+
if (prevConfig !== false) {
|
|
75
|
+
return prevConfig
|
|
76
|
+
}
|
|
100
77
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
if (nextConfig !== false) {
|
|
104
|
-
return nextConfig
|
|
105
|
-
}
|
|
78
|
+
return resolveFromSidebarItems(sidebarItems.value, route.path, -1)
|
|
79
|
+
})
|
|
106
80
|
|
|
107
|
-
|
|
108
|
-
|
|
81
|
+
const nextNavLink = computed(() => {
|
|
82
|
+
const nextConfig = resolveFromFrontmatterConfig(frontmatter.value.next)
|
|
83
|
+
if (nextConfig !== false) {
|
|
84
|
+
return nextConfig
|
|
85
|
+
}
|
|
109
86
|
|
|
110
|
-
|
|
111
|
-
prevNavLink,
|
|
112
|
-
nextNavLink,
|
|
113
|
-
}
|
|
114
|
-
},
|
|
87
|
+
return resolveFromSidebarItems(sidebarItems.value, route.path, 1)
|
|
115
88
|
})
|
|
116
89
|
</script>
|
|
90
|
+
|
|
91
|
+
<template>
|
|
92
|
+
<nav v-if="prevNavLink || nextNavLink" class="page-nav">
|
|
93
|
+
<p class="inner">
|
|
94
|
+
<span v-if="prevNavLink" class="prev">
|
|
95
|
+
<AutoLink :item="prevNavLink" />
|
|
96
|
+
</span>
|
|
97
|
+
|
|
98
|
+
<span v-if="nextNavLink" class="next">
|
|
99
|
+
<AutoLink :item="nextNavLink" />
|
|
100
|
+
</span>
|
|
101
|
+
</p>
|
|
102
|
+
</nav>
|
|
103
|
+
</template>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import NavbarItems from '@theme/NavbarItems.vue'
|
|
3
|
+
import SidebarItems from '@theme/SidebarItems.vue'
|
|
4
|
+
</script>
|
|
5
|
+
|
|
6
|
+
<template>
|
|
7
|
+
<aside class="sidebar">
|
|
8
|
+
<NavbarItems />
|
|
9
|
+
<slot name="top" />
|
|
10
|
+
<SidebarItems />
|
|
11
|
+
<slot name="bottom" />
|
|
12
|
+
</aside>
|
|
13
|
+
</template>
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import AutoLink from '@theme/AutoLink.vue'
|
|
3
|
+
import DropdownTransition from '@theme/DropdownTransition.vue'
|
|
4
|
+
import { useToggle } from '@vueuse/core'
|
|
5
|
+
import { computed, nextTick, onBeforeUnmount, toRefs } from 'vue'
|
|
6
|
+
import type { PropType } from 'vue'
|
|
7
|
+
import { useRoute, useRouter } from 'vue-router'
|
|
8
|
+
import type { ResolvedSidebarItem } from '../../shared/index.js'
|
|
9
|
+
import { isActiveSidebarItem } from '../utils/index.js'
|
|
10
|
+
|
|
11
|
+
const props = defineProps({
|
|
12
|
+
item: {
|
|
13
|
+
type: Object as PropType<ResolvedSidebarItem>,
|
|
14
|
+
required: true,
|
|
15
|
+
},
|
|
16
|
+
depth: {
|
|
17
|
+
type: Number,
|
|
18
|
+
required: false,
|
|
19
|
+
default: 0,
|
|
20
|
+
},
|
|
21
|
+
})
|
|
22
|
+
|
|
23
|
+
const { item, depth } = toRefs(props)
|
|
24
|
+
const route = useRoute()
|
|
25
|
+
const router = useRouter()
|
|
26
|
+
|
|
27
|
+
const isActive = computed(() => isActiveSidebarItem(item.value, route))
|
|
28
|
+
const itemClass = computed(() => ({
|
|
29
|
+
'sidebar-item': true,
|
|
30
|
+
'sidebar-heading': depth.value === 0,
|
|
31
|
+
'active': isActive.value,
|
|
32
|
+
'collapsible': item.value.collapsible,
|
|
33
|
+
}))
|
|
34
|
+
|
|
35
|
+
const isOpenDefault = computed(() =>
|
|
36
|
+
item.value.collapsible ? isActive.value : true
|
|
37
|
+
)
|
|
38
|
+
const [isOpen, toggleIsOpen] = useToggle(isOpenDefault.value)
|
|
39
|
+
const onClick = (e: Event): void => {
|
|
40
|
+
if (item.value.collapsible) {
|
|
41
|
+
e.preventDefault()
|
|
42
|
+
// toggle open status on click
|
|
43
|
+
toggleIsOpen()
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// reset open status after navigation
|
|
48
|
+
const unregisterRouterHook = router.afterEach((to) => {
|
|
49
|
+
nextTick(() => {
|
|
50
|
+
isOpen.value = isOpenDefault.value
|
|
51
|
+
})
|
|
52
|
+
})
|
|
53
|
+
onBeforeUnmount(() => {
|
|
54
|
+
unregisterRouterHook()
|
|
55
|
+
})
|
|
56
|
+
</script>
|
|
57
|
+
|
|
58
|
+
<template>
|
|
59
|
+
<li>
|
|
60
|
+
<AutoLink v-if="item.link" :class="itemClass" :item="item" />
|
|
61
|
+
<p
|
|
62
|
+
v-else
|
|
63
|
+
tabindex="0"
|
|
64
|
+
:class="itemClass"
|
|
65
|
+
@click="onClick"
|
|
66
|
+
@keydown.enter="onClick"
|
|
67
|
+
>
|
|
68
|
+
{{ item.text }}
|
|
69
|
+
<span
|
|
70
|
+
v-if="item.collapsible"
|
|
71
|
+
class="arrow"
|
|
72
|
+
:class="isOpen ? 'down' : 'right'"
|
|
73
|
+
/>
|
|
74
|
+
</p>
|
|
75
|
+
|
|
76
|
+
<DropdownTransition v-if="item.children?.length">
|
|
77
|
+
<ul v-show="isOpen" class="sidebar-item-children">
|
|
78
|
+
<SidebarItem
|
|
79
|
+
v-for="child in item.children"
|
|
80
|
+
:key="`${depth}${child.text}${child.link}`"
|
|
81
|
+
:item="child"
|
|
82
|
+
:depth="depth + 1"
|
|
83
|
+
/>
|
|
84
|
+
</ul>
|
|
85
|
+
</DropdownTransition>
|
|
86
|
+
</li>
|
|
87
|
+
</template>
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import SidebarItem from '@theme/SidebarItem.vue'
|
|
3
|
+
import { onMounted, watch } from 'vue'
|
|
4
|
+
import { useRoute } from 'vue-router'
|
|
5
|
+
import { useSidebarItems } from '../composables/index.js'
|
|
6
|
+
|
|
7
|
+
const route = useRoute()
|
|
8
|
+
const sidebarItems = useSidebarItems()
|
|
9
|
+
|
|
10
|
+
onMounted(() => {
|
|
11
|
+
watch(
|
|
12
|
+
() => route.hash,
|
|
13
|
+
(hash) => {
|
|
14
|
+
// get the sidebar DOM
|
|
15
|
+
const sidebar = document.querySelector('.sidebar')
|
|
16
|
+
if (!sidebar) return
|
|
17
|
+
|
|
18
|
+
// get the active sidebar item DOM, whose href equals to the current route
|
|
19
|
+
const activeSidebarItem = document.querySelector(
|
|
20
|
+
`.sidebar a.sidebar-item[href="${route.path}${hash}"]`
|
|
21
|
+
)
|
|
22
|
+
if (!activeSidebarItem) return
|
|
23
|
+
|
|
24
|
+
// get the top and height of the sidebar
|
|
25
|
+
const { top: sidebarTop, height: sidebarHeight } =
|
|
26
|
+
sidebar.getBoundingClientRect()
|
|
27
|
+
// get the top and height of the active sidebar item
|
|
28
|
+
const { top: activeSidebarItemTop, height: activeSidebarItemHeight } =
|
|
29
|
+
activeSidebarItem.getBoundingClientRect()
|
|
30
|
+
|
|
31
|
+
// when the active sidebar item overflows the top edge of sidebar
|
|
32
|
+
if (activeSidebarItemTop < sidebarTop) {
|
|
33
|
+
// scroll to the top edge of sidebar
|
|
34
|
+
activeSidebarItem.scrollIntoView(true)
|
|
35
|
+
}
|
|
36
|
+
// when the active sidebar item overflows the bottom edge of sidebar
|
|
37
|
+
else if (
|
|
38
|
+
activeSidebarItemTop + activeSidebarItemHeight >
|
|
39
|
+
sidebarTop + sidebarHeight
|
|
40
|
+
) {
|
|
41
|
+
// scroll to the bottom edge of sidebar
|
|
42
|
+
activeSidebarItem.scrollIntoView(false)
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
)
|
|
46
|
+
})
|
|
47
|
+
</script>
|
|
48
|
+
|
|
49
|
+
<template>
|
|
50
|
+
<ul v-if="sidebarItems.length" class="sidebar-items">
|
|
51
|
+
<SidebarItem
|
|
52
|
+
v-for="item in sidebarItems"
|
|
53
|
+
:key="`${item.text}${item.link}`"
|
|
54
|
+
:item="item"
|
|
55
|
+
/>
|
|
56
|
+
</ul>
|
|
57
|
+
</template>
|