Files
kumomta/mkdocs-base.yml
T
Wez Furlong 3a1b1053bd docs: add link checking
Ideally there would be a good mkdocs based checker, but the
one that is out there only validate absolute URLs, which makes
it unsuitable for checking local relative links in the docs.

Adjust the doc build so that we also generate the SUMMARY.md
for mdbook, and use mdbook's link checker to check the links.

Fixup the couple of broken links that it found.
2023-03-13 12:01:07 -07:00

72 lines
1.6 KiB
YAML

copyright: Copyright © 2023 Kumo Corp
site_name: KumoMTA Docs
site_url: https://docs.kumomta.com
site_description: Documentation for KumoMTA
repo_url: https://github.com/kumomta/kumomta
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: gh_pages
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: orange
accent: deep purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: orange
accent: purple
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- content.action.edit
- content.action.view
- content.tabs.link
- navigation.footer
- navigation.indexes
- navigation.tabs
- navigation.top
- search.highlight
- search.share
- search.suggest
- toc.follow
plugins:
- search
- social
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- exclude:
glob:
- "**/_index.md"
- "generate_toc.py"
- "build.sh"
- "SUMMARY.md"
- "book.toml"
markdown_extensions:
- admonition
- pymdownx.details
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/kumomta/kumomta