docs: add product usage and operations guides
This commit is contained in:
@@ -0,0 +1,288 @@
|
||||
# yaml-language-server: $schema=./site.schema.json
|
||||
site:
|
||||
title: "无限邮箱文档"
|
||||
description: "无限邮箱的使用、部署与运维治理手册"
|
||||
url: "https://mail.shenjianl.cn"
|
||||
logo:
|
||||
light: "/images/favicon.svg"
|
||||
dark: "/images/favicon-dark.svg"
|
||||
author: "Email Unlimited"
|
||||
|
||||
navbar:
|
||||
showLogo: true
|
||||
showTitle: true
|
||||
showLanguageSwitcher: true
|
||||
items:
|
||||
- title: "首页"
|
||||
link: "/"
|
||||
active: true
|
||||
- title: "使用文档"
|
||||
link: "/docs"
|
||||
actions:
|
||||
- type: "gitea"
|
||||
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
|
||||
enabled: true
|
||||
|
||||
announcement:
|
||||
enabled: false
|
||||
|
||||
versions:
|
||||
enabled: false
|
||||
|
||||
changelog:
|
||||
enabled: false
|
||||
title: "更新日志"
|
||||
pageSize: 10
|
||||
|
||||
sidebar:
|
||||
enabled: true
|
||||
collapseControl:
|
||||
enabled: true
|
||||
defaultCollapsed: false
|
||||
collections:
|
||||
docs:
|
||||
sections:
|
||||
- title: "快速开始"
|
||||
path: "/docs/getting-started"
|
||||
children:
|
||||
- title: "产品介绍"
|
||||
path: "/docs/getting-started/introduction"
|
||||
- title: "本地开发"
|
||||
path: "/docs/getting-started/local-development"
|
||||
- title: "Docker 部署"
|
||||
path: "/docs/getting-started/docker-deployment"
|
||||
- title: "DNS 与 SMTP"
|
||||
path: "/docs/getting-started/dns-and-smtp"
|
||||
- title: "用户指南"
|
||||
path: "/docs/user-guide"
|
||||
children:
|
||||
- title: "账号与积分"
|
||||
path: "/docs/user-guide/account-and-credits"
|
||||
- title: "创建与管理邮箱"
|
||||
path: "/docs/user-guide/mailboxes"
|
||||
- title: "收件箱与附件"
|
||||
path: "/docs/user-guide/inbox"
|
||||
- title: "管理后台"
|
||||
path: "/docs/admin-guide"
|
||||
children:
|
||||
- title: "运行概览"
|
||||
path: "/docs/admin-guide/dashboard"
|
||||
- title: "资源与邮件治理"
|
||||
path: "/docs/admin-guide/governance"
|
||||
- title: "积分与审计"
|
||||
path: "/docs/admin-guide/credits-and-audit"
|
||||
- title: "运维手册"
|
||||
path: "/docs/operations"
|
||||
children:
|
||||
- title: "配置参考"
|
||||
path: "/docs/operations/configuration"
|
||||
- title: "备份与恢复"
|
||||
path: "/docs/operations/backup-and-restore"
|
||||
- title: "故障排查"
|
||||
path: "/docs/operations/troubleshooting"
|
||||
- title: "接口约定"
|
||||
path: "/docs/api"
|
||||
children:
|
||||
- title: "认证与公共约定"
|
||||
path: "/docs/api/authentication"
|
||||
|
||||
theme:
|
||||
defaultMode: "auto"
|
||||
allowToggle: true
|
||||
|
||||
toc:
|
||||
enabled: true
|
||||
maxLevel: 4
|
||||
collapseControl:
|
||||
enabled: true
|
||||
defaultCollapsed: false
|
||||
title: "本页目录"
|
||||
|
||||
imageViewer:
|
||||
enabled: true
|
||||
labels:
|
||||
preview: "预览图片"
|
||||
zoomIn: "放大"
|
||||
zoomOut: "缩小"
|
||||
fit: "适配窗口"
|
||||
actualSize: "原始比例"
|
||||
reset: "重置"
|
||||
rotateLeft: "左旋"
|
||||
rotateRight: "右旋"
|
||||
fullscreen: "全屏"
|
||||
download: "下载"
|
||||
openInNewTab: "新标签打开"
|
||||
close: "关闭图片查看器"
|
||||
|
||||
footer:
|
||||
enabled: true
|
||||
copyright: "© 2026 Email Unlimited"
|
||||
poweredBy: true
|
||||
repository:
|
||||
url: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
|
||||
branch: "limit-mail-freq"
|
||||
lastUpdated: "2026-07-25"
|
||||
version: "v1"
|
||||
groups:
|
||||
- title: "文档"
|
||||
items:
|
||||
- title: "快速开始"
|
||||
link: "/docs/getting-started"
|
||||
- title: "用户指南"
|
||||
link: "/docs/user-guide"
|
||||
- title: "运维手册"
|
||||
link: "/docs/operations"
|
||||
- title: "项目"
|
||||
items:
|
||||
- title: "源代码"
|
||||
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
|
||||
external: true
|
||||
- title: "开源许可"
|
||||
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit/src/branch/limit-mail-freq/LICENSE"
|
||||
external: true
|
||||
links:
|
||||
- title: "使用文档"
|
||||
link: "/docs"
|
||||
- title: "源代码"
|
||||
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
|
||||
external: true
|
||||
|
||||
pwa:
|
||||
enabled: true
|
||||
name: "无限邮箱文档"
|
||||
shortName: "无限邮箱"
|
||||
description: "无限邮箱的使用、部署与运维治理手册"
|
||||
themeColor: "#ffffff"
|
||||
backgroundColor: "#ffffff"
|
||||
|
||||
contextMenu:
|
||||
enabled: true
|
||||
page:
|
||||
copySelectedText: true
|
||||
copyUrl: true
|
||||
copyTitle: true
|
||||
copyMarkdownLink: true
|
||||
openInNewTab: true
|
||||
reload: true
|
||||
printPage: true
|
||||
scrollToTop: true
|
||||
scrollToBottom: true
|
||||
site:
|
||||
goHome: true
|
||||
quickNav: true
|
||||
language: true
|
||||
appearance:
|
||||
theme: true
|
||||
resetThemePref: true
|
||||
|
||||
mdx:
|
||||
componentsPath: "/src/components"
|
||||
enabled: true
|
||||
|
||||
pageMeta:
|
||||
showLastUpdated: true
|
||||
showEditLink: false
|
||||
showAuthors: true
|
||||
preferGitMeta: true
|
||||
|
||||
editLink:
|
||||
enabled: false
|
||||
label: "编辑此页"
|
||||
urlTemplate: ""
|
||||
|
||||
feedback:
|
||||
enabled: false
|
||||
endpoint: "/api/feedback"
|
||||
method: "POST"
|
||||
includePageMeta: true
|
||||
labels:
|
||||
helpful: "有帮助"
|
||||
unhelpful: "没帮助"
|
||||
inputPlaceholder: "可以补充哪里不清楚或不准确"
|
||||
submit: "提交反馈"
|
||||
thanks: "感谢反馈"
|
||||
|
||||
ai:
|
||||
enabled: false
|
||||
|
||||
backend:
|
||||
enabled: false
|
||||
baseUrl: "/api"
|
||||
features:
|
||||
auth: false
|
||||
comments: false
|
||||
bookmarks: false
|
||||
analytics: false
|
||||
feedback: false
|
||||
notifications: false
|
||||
admin: false
|
||||
|
||||
fonts:
|
||||
fontFamilyZhCn: "Noto Sans SC,MiSans, PingFang SC, Microsoft YaHei, sans-serif"
|
||||
fontFamilyEn: "Fragment Mono, system-ui, sans-serif"
|
||||
|
||||
codeHighlight:
|
||||
langs:
|
||||
- "bash"
|
||||
- "powershell"
|
||||
- "yaml"
|
||||
- "toml"
|
||||
- "json"
|
||||
- "javascript"
|
||||
- "vue"
|
||||
- "tsx"
|
||||
- "typescript"
|
||||
- "rust"
|
||||
- "sql"
|
||||
- "dockerfile"
|
||||
- "nginx"
|
||||
- "mermaid"
|
||||
lightTheme: "github-light"
|
||||
darkTheme: "github-dark"
|
||||
|
||||
search:
|
||||
enabled: true
|
||||
placeholder: "搜索使用、部署和运维文档..."
|
||||
maxResults: 20
|
||||
snippetLength: 120
|
||||
|
||||
seo:
|
||||
enabled: true
|
||||
defaultTitle: "无限邮箱文档"
|
||||
titleTemplate: "{title} | {siteTitle}"
|
||||
defaultDescription: "无限邮箱的使用、部署与运维治理手册"
|
||||
defaultOgImage: "https://mail.shenjianl.cn/images/og-default.png"
|
||||
robots: "index, follow"
|
||||
twitterCard: "summary_large_image"
|
||||
|
||||
breadcrumb:
|
||||
enabled: true
|
||||
showHome: true
|
||||
|
||||
reading:
|
||||
showTime: true
|
||||
showProgress: true
|
||||
fullscreen:
|
||||
enabled: true
|
||||
|
||||
sitemap:
|
||||
enabled: true
|
||||
changefreq: "weekly"
|
||||
priority: 0.7
|
||||
exclude: []
|
||||
|
||||
feed:
|
||||
enabled: false
|
||||
title: "无限邮箱文档"
|
||||
description: "无限邮箱文档更新"
|
||||
limit: 20
|
||||
|
||||
export:
|
||||
enabled: true
|
||||
markdown: true
|
||||
pdf: true
|
||||
word: true
|
||||
allDocs: true
|
||||
pdfServer:
|
||||
enabled: false
|
||||
url: "http://localhost:3001"
|
||||
Reference in New Issue
Block a user