VitePress 不完全优化指南

# package-lock=false
shamefully-hoist=true

import { type DefaultTheme, defineConfig } from 'vitepress'

// https://vitepress.dev/zh/reference/site-config
export default defineConfig({
    lang: 'zh-Hans',
    themeConfig: {
        // https://vitepress.dev/zh/reference/default-theme-config
        nav: nav(),
        sidebar: sidebar(),
        externalLinkIcon: true,
        langMenuLabel: '切换语言',
        darkModeSwitchLabel: '主题',
        lightModeSwitchTitle: '切换到浅色模式',
        darkModeSwitchTitle: '切换到深色模式',
        sidebarMenuLabel: '菜单',
        outline: { level: [2, 3], label: '目录' },
        returnToTopLabel: '返回顶部',
        // 请将此链接修改为正确的URL，或根据需求删除该配置
        // editLink: { pattern: 'https://github.com/username/repository-name/blame/main/docs/:path', text: '源代码', },
        lastUpdated: { text: '更新于' },
        docFooter: { prev: '上一篇', next: '下一篇' },
    },
})

// 将导航和侧边栏逻辑提取到外部，便于根据文档结构进行维护
function nav(): DefaultTheme.NavItem[] {
    return []
}

function sidebar(): DefaultTheme.Sidebar {
    return { '/': [] }
}

*.md linguist-detectable=true
docs/** linguist-documentation=false

// https://vitepress.dev/zh/guide/custom-theme
import type { Theme } from 'vitepress'
import { Icon } from '@iconify/vue'
import DefaultTheme from 'vitepress/theme-without-fonts'
import { h } from 'vue'

import Footer from '../components/Footer.vue'
import NotFound from '../components/NotFound.vue'

import './theme-enhanced.css'
import './style.css'

export default {
    extends: DefaultTheme,
    Layout: () => {
        return h(DefaultTheme.Layout, null, {
            // https://vitepress.dev/zh/guide/extending-default-theme#layout-slots
            'doc-bottom': () => h(Footer),
            'not-found': () => h(NotFound),
        })
    },
    enhanceApp({ app, router, siteData }) {
        app.component('Icon', Icon)
    },
} satisfies Theme

.fa-solid, .fa-regular, .fa-brands {
    width: 1.2em;
    vertical-align: middle;
    text-align: center;
}

:where(.iconify) {
    display: inline-block;
    flex-shrink: 0;
    font-size: 1.2em;
    vertical-align: sub;
}

.vp-doc .custom-block {
    padding: 8px 16px;
}

.vp-doc .custom-block :first-child:first-child {
    margin: 8px 0;
}

.VPMenuGroup > .title {
    font-size: 0.7em;
}

.vp-doc a {
    background: linear-gradient(var(--vp-c-brand-soft), var(--vp-c-brand-soft)) no-repeat center bottom / 100% 2px;
    text-decoration: none;
    transition: 0.2s;
}

.vp-doc a:hover {
    border-radius: 0.2em;
    background: linear-gradient(var(--vp-c-brand-soft), var(--vp-c-brand-soft)) no-repeat center bottom / 100% 100%;
}

.vp-doc strong {
    background: linear-gradient(var(--vp-c-brand-soft), var(--vp-c-brand-soft)) no-repeat center bottom / 100% 40%;
}

.vp-doc s {
    opacity: 0.6;
}

.some-comp.some-comp a {
    background: unset;
}

.some-comp.some-comp a[target]::after {
    content: unset;
}

/* 首页 Feature 图标样式 */
.VPFeature {
    position: relative;
    overflow: hidden;
    z-index: 0;
}

.VPFeature .icon {
    position: absolute;
    opacity: 0.15;
    right: 10%;
    background-color: transparent;
    font-size: 8em;
    z-index: -1;
}

/* 文档二级标题编号 */
.vp-doc {
    counter-reset: section-counter;
}

.vp-doc h2 {
    counter-increment: section-counter;
}

.vp-doc h2::before {
    content: counter(section-counter);
    position: absolute;
    left: -2rem;
    font-size: 3rem;
    font-weight: bold;
    color: var(--vp-c-divider);
    z-index: -1;
}