📝 Build document directory structure

This commit is contained in:
2025-11-03 22:49:38 +08:00
parent 0b16d1d4ac
commit e4d3969e95
13 changed files with 974 additions and 217 deletions

View File

@@ -4,7 +4,6 @@ import {defineConfig} from 'vitepress'
export default defineConfig({
title: "voidraft",
description: "An elegant text snippet recording tool designed for developers.",
lang: 'zh-CN',
srcDir: 'src',
assetsDir: 'assets',
cacheDir: './.vitepress/cache',
@@ -12,75 +11,111 @@ export default defineConfig({
srcExclude: [],
ignoreDeadLinks: false,
head: [
[
"link",
{
rel: "icon",
type: "image/png",
href: "/static/icon/favicon-96x96.png",
sizes: "96x96",
},
],
[
"link",
{
rel: "icon",
type: "image/svg+xml",
href: "/static/icon/favicon.svg",
},
],
[
"link",
{
rel: "shortcut icon",
href: "/static/icon/favicon.ico",
},
],
[
"link",
{
rel: "apple-touch-icon",
sizes: "180x180",
href: "/static/icon/apple-touch-icon.png",
},
],
[
"meta",
{
name: "apple-mobile-web-app-title",
content: "voidraft",
},
],
[
"link",
{
rel: "manifest",
href: "/static/icon/site.webmanifest",
},
],
['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}]
["link", { rel: "icon", type: "image/png", href: "/static/icon/favicon-96x96.png", sizes: "96x96" }],
["link", { rel: "icon", type: "image/svg+xml", href: "/static/icon/favicon.svg" }],
["link", { rel: "shortcut icon", href: "/static/icon/favicon.ico" }],
["link", { rel: "apple-touch-icon", sizes: "180x180", href: "/static/icon/apple-touch-icon.png" }],
["meta", { name: "apple-mobile-web-app-title", content: "voidraft" }],
["link", { rel: "manifest", href: "/static/icon/site.webmanifest" }],
['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1' }]
],
themeConfig: {
logo: '/static/icon/logo.png',
siteTitle: 'voidraft',
// https://vitepress.dev/reference/default-theme-config
nav: [
{text: 'Home', link: '/'},
{text: 'Examples', link: '/markdown-examples'}
],
sidebar: [
{
text: 'Examples',
items: [
{text: 'Markdown Examples', link: '/markdown-examples'},
{text: 'Runtime API Examples', link: '/api-examples'}
]
// 国际化配置
locales: {
root: {
label: 'English',
lang: 'en-US',
description: 'An elegant text snippet recording tool designed for developers.',
themeConfig: {
logo: '/static/icon/logo.png',
siteTitle: 'voidraft',
nav: [
{text: 'Home', link: '/'},
{text: 'Guide', link: '/guide/introduction'}
],
sidebar: {
'/guide/': [
{
text: 'Getting Started',
items: [
{text: 'Introduction', link: '/guide/introduction'},
{text: 'Installation', link: '/guide/installation'},
{text: 'Quick Start', link: '/guide/getting-started'}
]
},
{
text: 'Features',
items: [
{text: 'Overview', link: '/guide/features'}
]
}
]
},
socialLinks: [
{icon: 'github', link: 'https://github.com/landaiqing/voidraft'}
],
outline: {
label: 'On this page'
},
lastUpdated: {
text: 'Last updated'
},
docFooter: {
prev: 'Previous',
next: 'Next'
},
darkModeSwitchLabel: 'Appearance',
sidebarMenuLabel: 'Menu',
returnToTopLabel: 'Return to top'
}
],
socialLinks: [
{icon: 'github', link: 'https://github.com/landaiqing/voidraft'}
]
},
zh: {
label: '简体中文',
lang: 'zh-CN',
link: '/zh/',
description: '一个为开发者设计的优雅文本片段记录工具',
themeConfig: {
logo: '/static/icon/logo.png',
siteTitle: 'voidraft',
nav: [
{text: '首页', link: '/zh/'},
{text: '指南', link: '/zh/guide/introduction'}
],
sidebar: {
'/zh/guide/': [
{
text: '开始使用',
items: [
{text: '简介', link: '/zh/guide/introduction'},
{text: '安装', link: '/zh/guide/installation'},
{text: '快速开始', link: '/zh/guide/getting-started'}
]
},
{
text: '功能特性',
items: [
{text: '功能概览', link: '/zh/guide/features'}
]
}
]
},
socialLinks: [
{icon: 'github', link: 'https://github.com/landaiqing/voidraft'}
],
outline: {
label: '本页目录'
},
lastUpdated: {
text: '最后更新'
},
docFooter: {
prev: '上一页',
next: '下一页'
},
darkModeSwitchLabel: '外观',
sidebarMenuLabel: '菜单',
returnToTopLabel: '返回顶部'
}
}
}
})