mirror of
https://github.com/docker-mailserver/docker-mailserver
synced 2024-09-29 11:41:18 +02:00
021e942c4c
Consistency pass, formatting cleanup and fixes, introduce admonitions, add front-matter. --- docs: Add front-matter --- docs: Fix and format links - Some links were invalid (eg files moved or renamed) - Some were valid but had invalid section headers (content removed or migrated) - Some use `http://` instead of `https://` when the website supports a secure connection. - Some already used the `[name][reference]` convention but often with a number that wasn't as useful for maintenance. - All referenced docs needed URLs replaced. Opted for the `[name][reference]` approach to group them all clearly at the bottom of the doc, especially with the relative URLs and in some cases many duplicate entries. - All `tomav` references from the original repo prior to switch to an organization have been corrected. - Minor cosmetic changes to the `name` part of the URL, such as for referencing issues to be consistent. - Some small changes to text body, usually due to duplicate URL reference that was unnecessary (open relay, youtous) - Switched other links to use the `[name][reference]` format when there was a large group of URLs such as wikipedia or kubernetes. Github repos that reference projects related to `docker-mailserver` also got placed here so they're noticed better by maintainers. This also helped quite a bit with `mermaid` external links that are very long. - There was a Github Wiki supported syntax in use `[[name | link]]` for `fetchmail` page that isn't compatible by default with MkDocs (needs a plugin), converted to `[name][reference]` instead since it's a relative link. --- docs: Update commit link for LDAP override script Logic moved to another file, keeping the permalink commit reference so it's unaffected by any changes in the file referenced in future. --- docs: Heading corrections Consistency pass. Helps with the Table of Contents (top-right UI) aka Document Outline. docs: codefence cleanup --- docs: misc cleanup --- docs: Add Admonitions Switches `<details>` usage for collapsible admonitions (`???`) while other text content is switched to the visually more distinct admoniton (`!!!` or `???+`) style. This does affect editor syntax highlighting a bit and markdown linting as it's custom non-standard markdown syntax.
61 lines
1.9 KiB
YAML
61 lines
1.9 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>'
|
|
|
|
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
|