msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

revert(theme): revert 'allow setting base path in sidebar items'

Browse Source 
closes #2752
pull/2753/head
Divyansh Singh 1 year ago
parent 7141a83d74
commit 2fe8f60681
3 changed files with 40 additions and 58 deletions
Show Stats Download Patch File Download Diff File

74
docs/.vitepress/config.ts
Unescape View File

@ -53,8 +53,8 @@ export default defineConfig({
nav: nav(), nav: nav(),
sidebar: { sidebar: {
'/guide/': { base: '/guide/', items: sidebarGuide() }, '/guide/': sidebarGuide(),
'/reference/': { base: '/reference/', items: sidebarReference() } '/reference/': sidebarReference()
}, },
editLink: { editLink: {
@ -122,72 +122,72 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
text: 'Introduction', text: 'Introduction',
collapsed: false, collapsed: false,
items: [ items: [
{ text: 'What is VitePress?', link: 'what-is-vitepress' }, { text: 'What is VitePress?', link: '/guide/what-is-vitepress' },
{ text: 'Getting Started', link: 'getting-started' }, { text: 'Getting Started', link: '/guide/getting-started' },
{ text: 'Routing', link: 'routing' }, { text: 'Routing', link: '/guide/routing' },
{ text: 'Deploy', link: 'deploy' } { text: 'Deploy', link: '/guide/deploy' }
] ]
}, },
{ {
text: 'Writing', text: 'Writing',
collapsed: false, collapsed: false,
items: [ items: [
{ text: 'Markdown Extensions', link: 'markdown' }, { text: 'Markdown Extensions', link: '/guide/markdown' },
{ text: 'Asset Handling', link: 'asset-handling' }, { text: 'Asset Handling', link: '/guide/asset-handling' },
{ text: 'Frontmatter', link: 'frontmatter' }, { text: 'Frontmatter', link: '/guide/frontmatter' },
{ text: 'Using Vue in Markdown', link: 'using-vue' }, { text: 'Using Vue in Markdown', link: '/guide/using-vue' },
{ text: 'Internationalization', link: 'i18n' } { text: 'Internationalization', link: '/guide/i18n' }
] ]
}, },
{ {
text: 'Customization', text: 'Customization',
collapsed: false, collapsed: false,
items: [ items: [
{ text: 'Using a Custom Theme', link: 'custom-theme' }, { text: 'Using a Custom Theme', link: '/guide/custom-theme' },
{ text: 'Extending the Default Theme', link: 'extending-default-theme' }, { text: 'Extending the Default Theme', link: '/guide/extending-default-theme' },
{ text: 'Build-Time Data Loading', link: 'data-loading' }, { text: 'Build-Time Data Loading', link: '/guide/data-loading' },
{ text: 'SSR Compatibility', link: 'ssr-compat' }, { text: 'SSR Compatibility', link: '/guide/ssr-compat' },
{ text: 'Connecting to a CMS', link: 'cms' } { text: 'Connecting to a CMS', link: '/guide/cms' }
] ]
}, },
{ {
text: 'Experimental', text: 'Experimental',
collapsed: false, collapsed: false,
items: [ items: [
{ text: 'MPA Mode', link: 'mpa-mode' }, { text: 'MPA Mode', link: '/guide/mpa-mode' },
{ text: 'Sitemap Generation', link: 'sitemap-generation' } { text: 'Sitemap Generation', link: '/guide/sitemap-generation' }
] ]
}, },
{ text: 'Config & API Reference', base: '/reference/', link: 'site-config' } { text: 'Config & API Reference', link: '/reference/site-config' }
] ]
} }
/* prettier-ignore */
function sidebarReference(): DefaultTheme.SidebarItem[] { function sidebarReference(): DefaultTheme.SidebarItem[] {
return [ return [
{ {
text: 'Reference', text: 'Reference',
items: [ items: [
{ text: 'Site Config', link: 'site-config' }, { text: 'Site Config', link: '/reference/site-config' },
{ text: 'Frontmatter Config', link: 'frontmatter-config' }, { text: 'Frontmatter Config', link: '/reference/frontmatter-config' },
{ text: 'Runtime API', link: 'runtime-api' }, { text: 'Runtime API', link: '/reference/runtime-api' },
{ text: 'CLI', link: 'cli' }, { text: 'CLI', link: '/reference/cli' },
{ {
text: 'Default Theme', text: 'Default Theme',
base: '/reference/default-theme-',
items: [ items: [
{ text: 'Overview', link: 'config' }, { text: 'Overview', link: '/reference/default-theme-config' },
{ text: 'Nav', link: 'nav' }, { text: 'Nav', link: '/reference/default-theme-nav' },
{ text: 'Sidebar', link: 'sidebar' }, { text: 'Sidebar', link: '/reference/default-theme-sidebar' },
{ text: 'Home Page', link: 'home-page' }, { text: 'Home Page', link: '/reference/default-theme-home-page' },
{ text: 'Footer', link: 'footer' }, { text: 'Footer', link: '/reference/default-theme-footer' },
{ text: 'Layout', link: 'layout' }, { text: 'Layout', link: '/reference/default-theme-layout' },
{ text: 'Badge', link: 'badge' }, { text: 'Badge', link: '/reference/default-theme-badge' },
{ text: 'Team Page', link: 'team-page' }, { text: 'Team Page', link: '/reference/default-theme-team-page' },
{ text: 'Prev / Next Links', link: 'prev-next-links' }, { text: 'Prev / Next Links', link: '/reference/default-theme-prev-next-links' },
{ text: 'Edit Link', link: 'edit-link' }, { text: 'Edit Link', link: '/reference/default-theme-edit-link' },
{ text: 'Last Updated Timestamp', link: 'last-updated' }, { text: 'Last Updated Timestamp', link: '/reference/default-theme-last-updated' },
{ text: 'Search', link: 'search' }, { text: 'Search', link: '/reference/default-theme-search' },
{ text: 'Carbon Ads', link: 'carbon-ads' } { text: 'Carbon Ads', link: '/reference/default-theme-carbon-ads' }
] ]
} }
] ]

17
src/client/theme-default/support/sidebar.ts
Unescape View File

@ -20,7 +20,7 @@ export function getSidebar(
_sidebar: DefaultTheme.Sidebar | undefined, _sidebar: DefaultTheme.Sidebar | undefined,
path: string path: string
): SidebarItem[] { ): SidebarItem[] {
if (Array.isArray(_sidebar)) return addBase(_sidebar) if (Array.isArray(_sidebar)) return _sidebar
if (_sidebar == null) return [] if (_sidebar == null) return []
path = ensureStartingSlash(path) path = ensureStartingSlash(path)
@ -34,10 +34,7 @@ export function getSidebar(
return path.startsWith(ensureStartingSlash(dir)) return path.startsWith(ensureStartingSlash(dir))
}) })
const sidebar = dir ? _sidebar[dir] : [] return dir ? _sidebar[dir] : []
return Array.isArray(sidebar)
? addBase(sidebar)
: addBase(sidebar.items, sidebar.base)
} }
/** /**
@ -107,13 +104,3 @@ export function hasActiveLink(
? hasActiveLink(path, items.items) ? hasActiveLink(path, items.items)
: false : false
} }
function addBase(items: SidebarItem[], _base?: string): SidebarItem[] {
return [...items].map((_item) => {
const item = { ..._item }
const base = item.base || _base
if (base && item.link) item.link = base + item.link
if (item.items) item.items = addBase(item.items, base)
return item
})
}

7
types/default-theme.d.ts vendored
Unescape View File

@ -202,7 +202,7 @@ export namespace DefaultTheme {
export type Sidebar = SidebarItem[] | SidebarMulti export type Sidebar = SidebarItem[] | SidebarMulti
export interface SidebarMulti { export interface SidebarMulti {
[path: string]: SidebarItem[] | { items: SidebarItem[]; base: string } [path: string]: SidebarItem[]
} }
export type SidebarItem = { export type SidebarItem = {
@ -230,11 +230,6 @@ export namespace DefaultTheme {
*/ */
collapsed?: boolean collapsed?: boolean
/**
* Base path for the children items.
*/
base?: string
/** /**
* Customize text that appears on the footer of previous/next page. * Customize text that appears on the footer of previous/next page.
*/ */

Write Preview
Loading…
Cancel
Save