shenjianZ/email-unlimit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add product usage and operations guides

Browse Source
This commit is contained in:
shenjianZ
2026-07-25 23:23:56 +08:00
parent 32e0969ca1
commit 099e05fb56
80 changed files with 7887 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/public/config/site.en.yaml
+275
View File
@@ -0,0 +1,275 @@
# yaml-language-server: $schema=./site.schema.json
site:
title: "Email Unlimited Docs"
description: "User, deployment, and operations documentation for Email Unlimited"
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: "Home"
link: "/"
active: true
- title: "Documentation"
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: "Changelog"
pageSize: 10
sidebar:
enabled: true
collapseControl:
enabled: true
defaultCollapsed: false
collections:
docs:
sections:
- title: "Getting Started"
path: "/docs/getting-started"
children:
- title: "Introduction"
path: "/docs/getting-started/introduction"
- title: "Local Development"
path: "/docs/getting-started/local-development"
- title: "Docker Deployment"
path: "/docs/getting-started/docker-deployment"
- title: "DNS and SMTP"
path: "/docs/getting-started/dns-and-smtp"
- title: "User Guide"
path: "/docs/user-guide"
children:
- title: "Account and Credits"
path: "/docs/user-guide/account-and-credits"
- title: "Mailbox Management"
path: "/docs/user-guide/mailboxes"
- title: "Inbox and Attachments"
path: "/docs/user-guide/inbox"
- title: "Admin Guide"
path: "/docs/admin-guide"
children:
- title: "Operations Dashboard"
path: "/docs/admin-guide/dashboard"
- title: "Resource and Mail Governance"
path: "/docs/admin-guide/governance"
- title: "Credits and Audit"
path: "/docs/admin-guide/credits-and-audit"
- title: "Operations"
path: "/docs/operations"
children:
- title: "Configuration"
path: "/docs/operations/configuration"
- title: "Backup and Restore"
path: "/docs/operations/backup-and-restore"
- title: "Troubleshooting"
path: "/docs/operations/troubleshooting"
- title: "API Conventions"
path: "/docs/api"
children:
- title: "Authentication and Common Rules"
path: "/docs/api/authentication"
theme:
defaultMode: "auto"
allowToggle: true
toc:
enabled: true
maxLevel: 4
collapseControl:
enabled: true
defaultCollapsed: false
title: "On this page"
imageViewer:
enabled: true
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: "Documentation"
items:
- title: "Getting Started"
link: "/docs/getting-started"
- title: "User Guide"
link: "/docs/user-guide"
- title: "Operations"
link: "/docs/operations"
- title: "Project"
items:
- title: "Source"
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
external: true
- title: "License"
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit/src/branch/limit-mail-freq/LICENSE"
external: true
links:
- title: "Documentation"
link: "/docs"
- title: "Source"
link: "https://gitea.shenjianl.cn/shenjianZ/email-unlimit"
external: true
pwa:
enabled: true
name: "Email Unlimited Docs"
shortName: "Email Unlimited"
description: "User, deployment, and operations documentation for Email Unlimited"
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: "Edit this page"
urlTemplate: ""
feedback:
enabled: false
endpoint: "/api/feedback"
method: "POST"
includePageMeta: true
labels:
helpful: "Helpful"
unhelpful: "Not helpful"
inputPlaceholder: "Tell us what is unclear or missing"
submit: "Submit"
thanks: "Thanks for your feedback"
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: "Search user, deployment, and operations docs..."
maxResults: 20
snippetLength: 120
seo:
enabled: true
defaultTitle: "Email Unlimited Docs"
titleTemplate: "{title} | {siteTitle}"
defaultDescription: "User, deployment, and operations documentation for Email Unlimited"
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: "Email Unlimited Docs"
description: "Email Unlimited documentation updates"
limit: 20
export:
enabled: true
markdown: true
pdf: true
word: true
allDocs: true
pdfServer:
enabled: false
url: "http://localhost:3001"
docs/public/config/site.schema.json
+111
View File
@@ -0,0 +1,111 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "React Docs UI site config",
"type": "object",
"additionalProperties": true,
"properties": {
"breadcrumb": { "$ref": "#/$defs/breadcrumb" },
"reading": { "$ref": "#/$defs/reading" },
"sidebar": { "$ref": "#/$defs/sidebar" },
"toc": { "$ref": "#/$defs/toc" },
"footer": { "$ref": "#/$defs/footer" },
"sitemap": { "$ref": "#/$defs/sitemap" },
"feed": { "$ref": "#/$defs/feed" }
},
"$defs": {
"collapseControl": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"defaultCollapsed": { "type": "boolean" }
}
},
"sidebar": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"collapseControl": { "$ref": "#/$defs/collapseControl" }
}
},
"toc": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"collapseControl": { "$ref": "#/$defs/collapseControl" },
"maxLevel": { "type": "integer", "minimum": 1, "maximum": 6 },
"title": { "type": "string" }
}
},
"footer": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"copyright": { "type": "string" },
"beian": { "$ref": "#/$defs/footerLink" },
"policeBeian": { "$ref": "#/$defs/footerLink" },
"poweredBy": { "type": "boolean" }
}
},
"footerLink": {
"type": "object",
"additionalProperties": true,
"properties": {
"text": { "type": "string" },
"url": { "type": "string" }
}
},
"breadcrumb": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"showHome": { "type": "boolean" }
}
},
"reading": {
"type": "object",
"additionalProperties": true,
"properties": {
"showTime": { "type": "boolean" },
"showProgress": { "type": "boolean" },
"fullscreen": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" }
}
}
}
},
"sitemap": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"changefreq": {
"type": "string",
"enum": ["always", "hourly", "daily", "weekly", "monthly", "yearly", "never"]
},
"priority": { "type": "number", "minimum": 0, "maximum": 1 },
"exclude": {
"type": "array",
"items": { "type": "string" }
}
}
},
"feed": {
"type": "object",
"additionalProperties": true,
"properties": {
"enabled": { "type": "boolean" },
"title": { "type": "string" },
"description": { "type": "string" },
"limit": { "type": "integer", "minimum": 1 }
}
}
}
}
docs/public/config/site.yaml
+288
View File
@@ -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"