Files
Dream Hunter 7d68cbdffa docs: improve deployment troubleshooting (#1011)
* docs: improve deployment troubleshooting docs

* docs: fix GitHub casing in FAQ

* docs: clarify subdomain address creation
2026-04-29 01:36:59 +08:00

197 lines
6.8 KiB
TypeScript

import { defineConfig, type DefaultTheme } from 'vitepress'
export const zh = defineConfig({
title: "临时邮箱文档",
lang: 'zh-Hans',
description: 'CloudFlare 免费收发临时域名邮箱,支持多域名、附件、Telegram Bot、Webhook、SMTP/IMAP',
head: [
['meta', { property: 'og:locale', content: 'zh_CN' }],
['meta', { property: 'og:description', content: 'CloudFlare 免费收发临时域名邮箱,支持多域名、附件、Telegram Bot、Webhook、SMTP/IMAP' }],
],
themeConfig: {
nav: nav(),
sidebar: {
'/zh/guide/': { base: '/zh/guide/', items: sidebarGuide() },
},
editLink: {
pattern: 'https://github.com/dreamhunter2333/cloudflare_temp_email/edit/main/vitepress-docs/docs/:path',
text: '在 GitHub 上编辑此页面'
},
footer: {
message: '基于 MIT 许可发布',
copyright: `版权所有 © 2023-${new Date().getFullYear()} Dream Hunter`
},
docFooter: {
prev: '上一页',
next: '下一页'
},
outline: {
level: 'deep',
label: '页面导航'
},
lastUpdated: {
text: '最后更新于',
formatOptions: {
dateStyle: 'short',
timeStyle: 'medium'
}
},
langMenuLabel: '多语言',
returnToTopLabel: '回到顶部',
sidebarMenuLabel: '菜单',
darkModeSwitchLabel: '主题',
lightModeSwitchTitle: '切换到浅色模式',
darkModeSwitchTitle: '切换到深色模式'
}
})
function nav(): DefaultTheme.NavItem[] {
return [
{
text: '主页',
link: '/zh/',
},
{
text: '指南',
link: '/zh/guide/quick-start',
activeMatch: '/zh/guide/'
},
{
text: '服务状态',
link: '/zh/status',
},
{
text: '参考',
link: '/zh/reference',
},
{
text: process.env.TAG_NAME || 'v0.2.2',
items: [
{
text: '更新日志',
link: 'https://github.com/dreamhunter2333/cloudflare_temp_email/blob/main/CHANGELOG.md'
},
{
text: '参与贡献',
link: 'https://github.com/dreamhunter2333/cloudflare_temp_email'
}
]
}
]
}
function sidebarGuide(): DefaultTheme.SidebarItem[] {
return [
{
text: '简介',
collapsed: false,
items: [
{ text: '什么是临时邮箱', link: 'what-is-temp-mail' },
{ text: 'Star History', link: 'star-history' },
{ text: '快速开始部署', link: 'quick-start' },
]
},
{
text: '通过命令行部署',
collapsed: false,
items: [
{ text: '命令行部署准备', link: 'cli/pre-requisite' },
{ text: 'D1 数据库', link: 'cli/d1' },
{ text: 'Cloudflare workers 后端', link: 'cli/worker' },
{ text: '配置邮件转发', link: 'email-routing.md' },
{ text: 'Cloudflare Pages 前端', link: 'cli/pages' },
{ text: '配置发送邮件', link: 'config-send-mail' },
]
},
{
text: '通过用户界面部署',
collapsed: false,
items: [
{ text: 'D1 数据库', link: 'ui/d1' },
{ text: 'Cloudflare workers 后端', link: 'ui/worker' },
{ text: '配置邮件转发', link: 'email-routing.md' },
{ text: 'Cloudflare Pages 前端', link: 'ui/pages' },
{ text: '配置发送邮件', link: 'config-send-mail' },
]
},
{
text: '通过 Github Actions 部署',
collapsed: true,
items: [
{ text: 'Github Actions 部署准备', link: 'actions/pre-requisite' },
{ text: 'D1 数据库', link: 'actions/d1' },
{ text: 'Github Actions 配置', link: 'actions/github-action' },
{ text: '配置邮件转发', link: 'email-routing.md' },
{ text: '配置发送邮件', link: 'config-send-mail' },
{ text: '自动更新配置', link: 'actions/auto-update' },
]
},
{
text: '核心配置',
collapsed: false,
items: [
{ text: 'Worker 变量说明', link: 'worker-vars' },
{ text: '配置发送邮件', link: 'config-send-mail' },
]
},
{
text: '帮助',
collapsed: false,
items: [
{ text: '常见问题 (FAQ)', link: 'common-issues' },
]
},
{
text: '通知与集成',
collapsed: false,
items: [
{ text: '配置 Telegram Bot', link: 'feature/telegram' },
{ text: '配置 webhook', link: 'feature/webhook' },
{ text: '配置 SMTP/IMAP 邮件客户端', link: 'feature/config-smtp-proxy' },
{ text: 'Oauth2 第三方登录', link: 'feature/user-oauth2' },
]
},
{
text: '高级功能',
collapsed: false,
items: [
{ text: 'AI 邮件识别', link: 'feature/ai-extract' },
{ text: '配置子域名邮箱', link: 'feature/subdomain' },
{ text: '配置 S3 附件', link: 'feature/s3-attachment' },
{ text: '配置 worker 使用 wasm 解析邮件', link: 'feature/mail_parser_wasm_worker' },
{ text: '配置其他 worker 增强', link: 'feature/another-worker-enhanced' },
{ text: '给网页增加 Google Ads', link: 'feature/google-ads.md' },
]
},
{
text: 'API 接口',
collapsed: false,
items: [
{ text: '新建邮箱地址 API', link: 'feature/new-address-api' },
{ text: '查看邮件 API', link: 'feature/mail-api' },
{ text: 'AI Agent 使用邮箱', link: 'feature/agent-email' },
{ text: '发送邮件 API', link: 'feature/send-mail-api' },
{ text: '删除邮箱地址 API', link: 'feature/delete-address' },
]
},
{
text: '管理后台',
collapsed: false,
items: [
{ text: 'Admin 控制台', link: 'feature/admin' },
{ text: 'Admin 用户管理', link: 'feature/admin-user-management' },
]
},
{ text: '参考', base: "/zh/", link: 'reference' }
]
}