email-unlimit/docs/public/config/site.en.yaml

# 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"