mirror of
https://blitiri.com.ar/repos/chasquid
synced 2026-10-28 15:02:28 +00:00
Alberto Bertogli
9a59bd77d1
This patch uses mdformat to auto-format markdown documentation. To support \ for line breaks (which is what mdformat uses), mkdocs now requires the pymdownx.escapeall extension. Because of incompatibilities between mdformat (which formats to CommonMark) and mkdocs (which expects Python-Markdown), there are now some limitations: no nested lists, multi-paragraph list items, or admonitions support. These limitations are acceptable for now, although some of the docs had to be adjusted to meet them.
51 lines
855 B
YAML
51 lines
855 B
YAML
# mkdocs configuration
|
|
#
|
|
# To test changes locally, run:
|
|
# mkdocs serve -f .mkdocs.yml
|
|
|
|
site_name: chasquid documentation
|
|
|
|
# Point the repo to github to make it easier for users to do edits, even if
|
|
# it's not the canonical location.
|
|
repo_url: https://github.com/albertito/chasquid
|
|
|
|
markdown_extensions:
|
|
- codehilite:
|
|
guess_lang: false
|
|
- attr_list
|
|
- admonition
|
|
- pymdownx.escapeall:
|
|
hardbreak: true
|
|
|
|
theme: readthedocs
|
|
|
|
exclude_docs: |
|
|
man/*.1
|
|
man/*.5
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- How-to: howto.md
|
|
- Install: install.md
|
|
- Manpages: man/index.md
|
|
- All:
|
|
- aliases.md
|
|
- hooks.md
|
|
- clients.md
|
|
- dovecot.md
|
|
- dkim.md
|
|
- haproxy.md
|
|
- docker.md
|
|
- flow.md
|
|
- monitoring.md
|
|
- sec-levels.md
|
|
- tests.md
|
|
- relnotes.md
|
|
- knownissues.md
|
|
- contributing.md
|
|
|
|
not_in_nav: |
|
|
security.md
|
|
man/*
|
|
|