mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
237a932f8e
Various PR commits related to the nav section have been merged together: docs: Fix indentation for linter check docs: update edit uri to content subdirectory docs: add ghcr link docs: shorten nav entry name docs: quote ghcr nav entry docs(config): update nav section for relocated documents Additional nav section fixes: - consistent usage of quotes - eclint padding error - wrong indentation of pop3 - remove a leading slash from a filepath
112 lines
4.4 KiB
YAML
112 lines
4.4 KiB
YAML
site_name: 'Docker Mailserver'
|
|
site_description: 'A fullstack but simple mail server (SMTP, IMAP, LDAP, Antispam, Antivirus, etc.) using Docker.'
|
|
site_author: 'docker-mailserver (Github Organization)'
|
|
repo_name: 'docker-mailserver'
|
|
repo_url: 'https://github.com/docker-mailserver/docker-mailserver'
|
|
copyright: '<p>© <a href="https://github.com/docker-mailserver"><em>Docker Mailserver Organization</em></a><br/><span>This project is licensed under the MIT license.</span></p>'
|
|
edit_uri: 'edit/master/docs/content'
|
|
docs_dir: 'content/'
|
|
site_url: 'https://docker-mailserver.github.io/docker-mailserver'
|
|
theme:
|
|
name: 'material'
|
|
favicon: assets/logo/favicon-32x32.png
|
|
logo: assets/logo/dmo-logo-white.svg
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.expand
|
|
- navigation.instant
|
|
|
|
extra_css:
|
|
- assets/css/customizations.css
|
|
|
|
# We do not use `mike`, but enabling this will enable the version selector UI.
|
|
# It references `versions.json` on `gh-pages` branch,
|
|
# however we have a basic setup that only matches `version` to a subdirectory.
|
|
extra:
|
|
version:
|
|
provider: mike
|
|
|
|
markdown_extensions:
|
|
- toc:
|
|
anchorlink: true
|
|
- abbr
|
|
- attr_list
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
extend_pygments_lang:
|
|
- name: yml
|
|
lang: yaml
|
|
- name: cf
|
|
lang: cfg
|
|
- name: conf
|
|
lang: cfg
|
|
- name: env
|
|
lang: properties
|
|
# Not helpful with Python Pygments lexer highlighting, but we might change to a JS highlighter in future
|
|
# Ideally, this type of codefence might also have word-wrap enabled (CSS: {white-space: pre-wrap})
|
|
- name: log
|
|
lang: shell-session
|
|
- name: fetchmailrc
|
|
lang: txt
|
|
- name: caddyfile
|
|
lang: txt
|
|
- pymdownx.superfences
|
|
- pymdownx.magiclink
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
|
|
nav:
|
|
- 'Home': index.md
|
|
- 'Introduction': introduction.md
|
|
- 'Configuration':
|
|
- 'Your Best Friend setup.sh': config/setup.sh.md
|
|
- 'User Management':
|
|
- 'Accounts': config/user-management/accounts.md
|
|
- 'Aliases': config/user-management/aliases.md
|
|
- 'Best Practices':
|
|
- 'DKIM': config/best-practices/dkim.md
|
|
- 'DMARC': config/best-practices/dmarc.md
|
|
- 'SPF': config/best-practices/spf.md
|
|
- 'Auto-discovery': config/best-practices/autodiscover.md
|
|
- 'Security':
|
|
- 'Understanding the Ports': config/security/understanding-the-ports.md
|
|
- 'SSL/TLS': config/security/ssl.md
|
|
- 'Fail2Ban': config/security/fail2ban.md
|
|
- 'Troubleshooting':
|
|
- 'Debugging': config/troubleshooting/debugging.md
|
|
- 'Mail Delivery with POP3': config/pop3.md
|
|
- 'Advanced Configuration':
|
|
- 'Optional Configuration': config/advanced/optional-config.md
|
|
- 'Maintenance':
|
|
- 'Update and Cleanup': config/advanced/maintenance/update-and-cleanup.md
|
|
- 'Override the Default Configs':
|
|
- 'Dovecot': config/advanced/override-defaults/dovecot.md
|
|
- 'Postfix': config/advanced/override-defaults/postfix.md
|
|
- 'LDAP Authentication': config/advanced/auth-ldap.md
|
|
- 'Email Filtering with Sieve': config/advanced/mail-sieve.md
|
|
- 'Email Gathering with Fetchmail': config/advanced/mail-fetchmail.md
|
|
- 'Email Forwarding':
|
|
- 'Relay Hosts': config/advanced/mail-forwarding/relay-hosts.md
|
|
- 'AWS SES': config/advanced/mail-forwarding/aws-ses.md
|
|
- 'Full-Text Search': config/advanced/full-text-search.md
|
|
- 'Kubernetes': config/advanced/kubernetes.md
|
|
- 'IPv6': config/advanced/ipv6.md
|
|
- 'Examples':
|
|
- 'Tutorials':
|
|
- 'Basic Installation': examples/tutorials/basic-installation.md
|
|
- 'Mailserver behind Proxy': examples/tutorials/mailserver-behind-proxy.md
|
|
- 'Use Cases':
|
|
- 'Forward-Only Mailserver with LDAP': examples/uses-cases/forward-only-mailserver-with-ldap-authentication.md
|
|
- 'FAQ' : faq/faq.md
|
|
- 'Contributing':
|
|
- 'Issues and Pull Requests': contributing/issues-and-pull-requests.md
|
|
- 'Coding Style': contributing/coding-style.md
|
|
- 'Tests': contributing/tests.md
|
|
- 'Documentation': contributing/documentation.md
|
|
- 'DockerHub': https://hub.docker.com/repository/docker/mailserver/docker-mailserver
|
|
- 'GHCR': https://github.com/orgs/docker-mailserver/packages/container/package/docker-mailserver
|