docs: Use mkdocs to render documentation

This commit is contained in:
fox.cpp 2019-12-06 23:23:02 +03:00
parent d886ddd297
commit 5f809c3157
No known key found for this signature in database
GPG key ID: E76D97CCEDE90B6C
5 changed files with 50 additions and 18 deletions

View file

@ -8,3 +8,7 @@ trim_trailing_whitespace = true
[*.{scd,go}] [*.{scd,go}]
indent_style = tab indent_style = tab
indent_size = 4 indent_size = 4
[*.yml]
indent_style = tab
indent_size = 2

29
.mkdocs.yml Normal file
View file

@ -0,0 +1,29 @@
site_name: maddy documentation
repo_url: https://github.com/foxcpp/maddy
theme: readthedocs
markdown_extensions:
- codehilite:
guess_lang: false
nav:
- README.md
- Tutorials:
- tutorials/setting-up.md
- tutorials/manual-installation.md
- get.sh.md
- Manual pages:
- man/_generated_maddy.1.md
- man/_generated_maddy-auth.5.md
- man/_generated_maddy-config.5.md
- man/_generated_maddy-filters.5.md
- man/_generated_maddy-imap.5.md
- man/_generated_maddy-smtp.5.md
- man/_generated_maddy-storage.5.md
- man/_generated_maddy-targets.5.md
- man/_generated_maddy-tls.5.md
- Internals:
- internals/quirks.md
- internals/sqlite.md

View file

@ -10,25 +10,26 @@ changes happen from time to time**
## Features ## Features
* Comprehensive & secure - Comprehensive & secure
- IMAP4rev1 & SMTP server in one binary - IMAP4rev1 & SMTP server in one binary
- [DKIM][dkim] signing and verification - [DKIM][dkim] signing and verification
- [SPF][spf] policy enforcement - [SPF][spf] policy enforcement
- [DMARC][dmarc] policy enforcement - [DMARC][dmarc] policy enforcement
- [MTA-STS][mtasts] policy enforcement - [MTA-STS][mtasts] policy enforcement
* Simple to configure - Simple to configure
- Two steps (excluding messing with DNS) to get your own - Two steps (excluding messing with DNS) to get your own
_secure_ mail server running _secure_ mail server running
- Virtual users > system users - Virtual users > system users
* Fast - Fast
- Optimized for concurrency - Optimized for concurrency
- Single process model allows more efficient implementation - Single process model allows more efficient implementation
* Useful - Useful
- [Subaddressing][subaddr] support - [Subaddressing][subaddr] support
- [DNSBL][dnsbl] checking support - [DNSBL][dnsbl] checking support
- Messages compression (LZ4, Zstd) - Messages compression (LZ4, Zstd)
Planned: Planned:
- [Backscatter][backscatter] filtering (BATV) (#106) - [Backscatter][backscatter] filtering (BATV) (#106)
- Address aliases (#82, #18) - Address aliases (#82, #18)
- Zero-configuration full-text search (foxcpp/go-imap-sql#21) - Zero-configuration full-text search (foxcpp/go-imap-sql#21)
@ -44,15 +45,10 @@ Detailed explaination of what you need to do to get it running can be found
## Documentation ## Documentation
Reference documentation is maintained as a set of man pages The full documentation is published [here](https://foxcpp.dev/maddy/)
in the [scdoc](https://git.sr.ht/~sircmpwn/scdoc) format.
Rendered pages can be browsed [here](https://foxcpp.dev/maddy-reference).
Tutorials and misc articles can be found on Examples of more advanced configurations with explainations can be found in the
the [project wiki](https://github.com/foxcpp/maddy/wiki). [examples](examples/) directory in the source repository.
Examples of more advanced configurations with explainations can be
found in the [examples](examples/) directory.
## Community ## Community
@ -79,4 +75,4 @@ The code is under MIT license. See [LICENSE](LICENSE) for more information.
[dnsbl]: https://en.wikipedia.org/wiki/DNSBL [dnsbl]: https://en.wikipedia.org/wiki/DNSBL
[backscatter]: https://en.wikipedia.org/wiki/Backscatter_(e-mail) [backscatter]: https://en.wikipedia.org/wiki/Backscatter_(e-mail)
[setup-tutorial]: https://github.com/foxcpp/maddy/wiki/Tutorial:-Setting-up-a-mail-server-with-maddy [setup-tutorial]: https://foxcpp.dev/maddy/tutorial/setting-up/

View file

@ -2,7 +2,7 @@
Description=maddy mail server Description=maddy mail server
Documentation=man:maddy(1) Documentation=man:maddy(1)
Documentation=man:maddy.conf(5) Documentation=man:maddy.conf(5)
Documentation=https://github.com/foxcpp/maddy/wiki Documentation=https://foxcpp.dev/maddy/
After=network.target After=network.target
[Service] [Service]

View file

@ -1,5 +1,8 @@
[Unit] [Unit]
Description=maddy mail server (using %i.conf) Description=maddy mail server (using %i.conf)
Documentation=man:maddy(1)
Documentation=man:maddy.conf(5)
Documentation=https://foxcpp.dev/maddy/
After=network.target After=network.target
[Service] [Service]