mirror of
https://blitiri.com.ar/repos/chasquid
synced 2026-10-29 15:02:30 +00:00
docs: Auto-format markdown documentation
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.
This commit is contained in:
+3
-5
@@ -2,8 +2,8 @@
|
||||
|
||||
From the latest Debian package:
|
||||
|
||||
- [chasquid(1)](https://manpages.debian.org/unstable/chasquid/chasquid.1):
|
||||
the main binary.
|
||||
- [chasquid(1)](https://manpages.debian.org/unstable/chasquid/chasquid.1): the
|
||||
main binary.
|
||||
- [chasquid.conf(5)](https://manpages.debian.org/unstable/chasquid/chasquid.conf.5):
|
||||
the configuration file and structure.
|
||||
- [chasquid-util(1)](https://manpages.debian.org/unstable/chasquid/chasquid-util.1):
|
||||
@@ -17,9 +17,7 @@ From the current branch (more likely to change, but useful when doing
|
||||
development or running experimental versions):
|
||||
|
||||
- [chasquid(1)](chasquid.1.md): the main binary.
|
||||
- [chasquid.conf(5)](chasquid.conf.5.md): the configuration file and
|
||||
structure.
|
||||
- [chasquid.conf(5)](chasquid.conf.5.md): the configuration file and structure.
|
||||
- [chasquid-util(1)](chasquid-util.1.md): the command-line utility helper.
|
||||
- [mda-lmtp(1)](mda-lmtp.1.md): helper to integrate with LMTP delivery.
|
||||
- [smtp-check(1)](smtp-check.1.md): SMTP setup checker.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user