Skip to content

feat(theme): adopt LobeHub-inspired documentation styles #792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
StarLand1 wants to merge 1 commit into from
Closed

feat(theme): adopt LobeHub-inspired documentation styles #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions .vitepress/theme/components/DocBreadcrumb.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<script setup lang="ts">
import { computed } from 'vue'
import { useData, useRoute, withBase } from 'vitepress'
import type { DefaultTheme } from 'vitepress'

const { theme, page, lang } = useData()
const route = useRoute()
const isZh = computed(() => lang.value.startsWith('zh'))

function normalize(path: string) {
return decodeURI(path.split(/[?#]/)[0]).replace(/\.(html|md)$/, '').replace(/\/$/, '')
}

function findPath(items: DefaultTheme.SidebarItem[], parents: DefaultTheme.SidebarItem[] = []): DefaultTheme.SidebarItem[] {
for (const item of items) {
const path = [...parents, item]
if (item.link && normalize(withBase(item.link)) === normalize(route.path)) return path
if (item.items) {
const found = findPath(item.items, path)
if (found.length) return found
}
}
return []
}

const crumbs = computed(() => {
const sidebar = theme.value.sidebar
if (!sidebar || typeof sidebar === 'string') return []
if (Array.isArray(sidebar)) return findPath(sidebar)
// A language or section may have its own sidebar; use the longest matching prefix.
const key = Object.keys(sidebar)
.filter(prefix => route.path.startsWith(withBase(prefix)))
.sort((a, b) => b.length - a.length)[0]
const value = key ? sidebar[key] : []
return findPath(Array.isArray(value) ? value : value?.items || [])
})

const title = computed(() => crumbs.value.at(-1)?.text || page.value.title)
const parents = computed(() => crumbs.value.slice(0, -1))
</script>

<template>
<nav class="doc-breadcrumb" :aria-label="isZh ? '文档路径' : 'Breadcrumb'">
<a :href="withBase(isZh ? '/zh/' : '/')">{{ isZh ? '文档' : 'Docs' }}</a>
<template v-for="(item, index) in parents" :key="index">
<span class="separator" aria-hidden="true">/</span>
<a v-if="item.link" :href="withBase(item.link)">{{ item.text }}</a>
<span v-else>{{ item.text }}</span>
</template>
<span class="separator" aria-hidden="true">/</span>
<span class="current" aria-current="page">{{ title }}</span>
</nav>
</template>

<style scoped>
.doc-breadcrumb {
display: flex;
flex-wrap: wrap;
align-items: center;
gap: 8px;
max-width: var(--df-md-reading-width);
margin: 0 auto 28px;
color: var(--df-md-text-3);
font-family: var(--df-md-font-sans);
font-size: 13px;
line-height: 1.6;
overflow-wrap: anywhere;
}
.doc-breadcrumb a { color: inherit; text-decoration: none; }
.doc-breadcrumb a:hover { color: var(--df-md-primary-6); }
.separator { color: var(--df-md-border-3); }
.current { color: var(--df-md-text-1); }
.doc-breadcrumb a:focus-visible {
outline: 2px solid var(--df-md-primary-6);
outline-offset: 3px;
}
@media (max-width: 959px) {
.doc-breadcrumb { margin-top: 8px; margin-bottom: 24px; }
}
</style>
287 changes: 287 additions & 0 deletions .vitepress/theme/document-ui.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,287 @@
/* Reading layout and navigation shared by normal and doc-only builds. */
.Layout:has(.VPDoc) {
--vp-sidebar-width: 272px;
--vp-font-family-base: var(--df-md-font-sans);
--vp-font-family-mono: var(--df-md-font-mono);
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDoc > .container > .content {
min-width: 0;
}

.Layout:has(.VPDoc) .VPDoc .content-container {
max-width: var(--df-md-reading-width);
}

.Layout:has(.VPDoc) .VPDoc > .container {
max-width: 1056px;
}

.Layout:has(.VPDoc) .VPDoc .aside {
max-width: 240px;
padding-left: 40px;
}

.Layout:has(.VPDoc) .VPDoc .aside-container,
.Layout:has(.VPDoc) .VPDoc .aside-curtain {
width: 200px;
}

.Layout:has(.VPDoc) .VPDoc .aside-container {
padding-top: calc(var(--vp-nav-height) + 48px);
}

.Layout:has(.VPDoc) .VPDocAsideOutline > .content {
padding: 0 0 0 16px;
border-color: var(--df-md-border-1);
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDocAsideOutline .outline-title {
margin-bottom: 8px;
color: var(--df-md-text-1);
font-weight: var(--df-md-font-strong);
}

.Layout:has(.VPDoc) .VPDocAsideOutline .outline-link {
color: var(--df-md-text-2);
line-height: 28px;
font-size: 13px;
}

.Layout:has(.VPDoc) .VPDocAsideOutline .outline-link:hover {
color: var(--df-md-text-1);
}

.Layout:has(.VPDoc) .VPDocAsideOutline .outline-link.active {
color: var(--df-md-text-1);
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDocAsideOutline .outline-marker {
background-color: var(--df-md-primary-6);
}

.Layout:has(.VPDoc) .VPSidebar {
font-family: var(--df-md-font-sans);
border-right: 1px solid var(--df-md-border-1);
}

.Layout:has(.VPDoc) .VPSidebar .group {
padding: 12px 0 0;
border-top: 0;
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem.level-0 {
padding-bottom: 8px;
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem.level-0 > .item .text {
padding: 8px 0;
font-size: 13px;
line-height: 20px;
font-weight: var(--df-md-font-normal);
color: var(--df-md-text-2);
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem:not(.level-0) > .item {
width: calc(100% + 8px);
margin-left: -8px;
padding-left: 8px;
border-radius: 8px;
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem:not(.level-0) > .item .text {
padding: 6px 8px 6px 0;
line-height: 22px;
font-size: 14px;
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem:not(.level-0) > .item:hover,
.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem.is-active > .item {
background-color: var(--df-md-fill-2);
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem.is-active > .item .text {
color: var(--df-md-text-1);
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem .items {
border-color: var(--df-md-border-1);
}

.Layout:has(.VPDoc) .VPSidebar .VPSidebarItem .caret {
align-self: center;
color: var(--df-md-text-3);
}

.Layout:has(.VPDoc) .VPSidebar .sidebar-actions {
width: 100%;
padding-bottom: 12px;
border-bottom: 0;
}

.Layout:has(.VPDoc) .sidebar-actions .search-box {
border-radius: 8px;
border-color: var(--df-md-border-1);
background: var(--df-md-bg-1);
}

.Layout:has(.VPDoc) .sidebar-actions .search-box:hover {
border-color: var(--df-md-border-2);
background: var(--df-md-fill-1);
}

.Layout:has(.VPDoc) .sidebar-actions .search-box:focus {
border-color: var(--df-md-primary-6);
}

.Layout:has(.VPDoc) .sidebar-actions .theme-toggle {
border-radius: 8px;
border-color: var(--df-md-border-1);
}

.Layout:has(.VPDoc) .doc-header {
--vp-c-text-1: var(--df-md-text-1);
--vp-c-text-2: var(--df-md-text-2);
--vp-c-text-3: var(--df-md-text-3);
--vp-c-border: var(--df-md-border-1);
--vp-c-brand-1: var(--df-md-primary-6);
--vp-c-bg: var(--df-md-bg-1);
--vp-c-bg-soft: var(--df-md-fill-1);
font-family: var(--df-md-font-sans);
}

.Layout:has(.VPDoc) .doc-header .doc-search,
.Layout:has(.VPDoc) .doc-header .theme-toggle,
.Layout:has(.VPDoc) .doc-header .lang-switch-trigger {
border-radius: 8px;
border-color: var(--df-md-border-1);
}

.Layout:has(.VPDoc) .doc-header .doc-search {
background: var(--df-md-bg-1);
}

.Layout:has(.VPDoc) .doc-header .doc-search:hover,
.Layout:has(.VPDoc) .doc-header .theme-toggle:hover,
.Layout:has(.VPDoc) .doc-header .lang-switch-trigger:hover {
border-color: var(--df-md-border-2);
background-color: var(--df-md-fill-1);
}

.Layout:has(.VPDoc) .doc-header .doc-search:focus {
border-color: var(--df-md-primary-6);
}

.Layout:has(.VPDoc) .VPDocFooter {
margin-top: 56px;
font-family: var(--df-md-font-sans);
}

.Layout:has(.VPDoc) .VPDocFooter .edit-link-button {
color: var(--df-md-text-3);
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDocFooter .edit-link-button:hover {
color: var(--df-md-primary-6);
}

.Layout:has(.VPDoc) .VPDocFooter .VPLastUpdated {
color: var(--df-md-text-3);
font-size: 13px;
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDocFooter .prev-next {
border-color: var(--df-md-border-1);
padding-top: 24px;
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link {
padding: 16px 20px;
border-color: var(--df-md-border-1);
border-radius: 12px;
background-color: var(--df-md-bg-1);
transition: background-color 0.2s, border-color 0.2s;
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link:hover {
border-color: var(--df-md-border-2);
background-color: var(--df-md-fill-1);
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link .desc {
margin-bottom: 8px;
color: var(--df-md-text-3);
font-size: 13px;
font-weight: var(--df-md-font-normal);
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link .title {
color: var(--df-md-text-1);
font-size: 16px;
line-height: 1.5;
font-weight: 500;
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link:hover .title {
color: var(--df-md-primary-6);
}

.Layout:has(.VPDoc) .embedded-sidebar-button {
color: var(--df-md-text-2);
background: var(--df-md-bg-1);
border-color: var(--df-md-border-1);
}

.Layout:has(.VPDoc) :is(.VPSidebar, .VPDocFooter, .doc-header, .embedded-sidebar-button) :is(a, button):focus-visible {
outline: 2px solid var(--df-md-primary-6);
outline-offset: 2px;
}

@media (min-width: 960px) {
.Layout:has(.VPDoc) .VPDoc {
padding: 40px 24px 0;
}

.Layout:has(.VPDoc) .VPDoc > .container > .content {
padding: 0 16px 96px;
}

.Layout:has(.VPDoc) .VPSidebar {
padding-left: 24px;
padding-right: 24px;
}
}

@media (min-width: 1280px) {
.Layout:has(.VPDoc) .VPDoc > .container > .content {
flex: 1 1 680px;
max-width: 744px;
}
}

@media (max-width: 639px) {
.Layout:has(.VPDoc) .VPDoc {
padding-left: 24px;
padding-right: 24px;
}

.Layout:has(.VPDoc) .VPDocFooter .pager-link {
padding: 14px 16px;
}
}

@media (prefers-reduced-motion: reduce) {
.Layout:has(.VPDoc) *,
.VPLocalSearchBox * {
scroll-behavior: auto;
transition-duration: 0.01ms;
animation-duration: 0.01ms;
}
}
Loading
Loading