Skip to content

Commit

Permalink
docs: Use mkdocs to render documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
foxcpp committed Dec 6, 2019
1 parent d886ddd commit 5f809c3
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 18 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ trim_trailing_whitespace = true
[*.{scd,go}]
indent_style = tab
indent_size = 4

[*.yml]
indent_style = tab
indent_size = 2
29 changes: 29 additions & 0 deletions .mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,31 @@
Simple, fast, secure all-in-one mail server.

**⚠️ Disclaimer: maddy is in development, many planned features are
missing, bugs are waiting to eat your messages and incompatible
missing, bugs are waiting to eat your messages and incompatible
changes happen from time to time**

## Features

* Comprehensive & secure
- Comprehensive & secure
- IMAP4rev1 & SMTP server in one binary
- [DKIM][dkim] signing and verification
- [SPF][spf] policy enforcement
- [DMARC][dmarc] policy enforcement
- [MTA-STS][mtasts] policy enforcement
* Simple to configure
- Simple to configure
- Two steps (excluding messing with DNS) to get your own
_secure_ mail server running
- Virtual users > system users
* Fast
- Fast
- Optimized for concurrency
- Single process model allows more efficient implementation
* Useful
- [Subaddressing][subaddr] support
- Useful
- [Subaddressing][subaddr] support
- [DNSBL][dnsbl] checking support
- Messages compression (LZ4, Zstd)

Planned:

- [Backscatter][backscatter] filtering (BATV) (#106)
- Address aliases (#82, #18)
- Zero-configuration full-text search (foxcpp/go-imap-sql#21)
Expand All @@ -40,19 +41,14 @@ Planned:
## Installation & configuration

Detailed explaination of what you need to do to get it running can be found
[here][setup-tutorial].
[here][setup-tutorial].

## Documentation

Reference documentation is maintained as a set of man pages
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
the [project wiki](https://github.com/foxcpp/maddy/wiki).
The full documentation is published [here](https://foxcpp.dev/maddy/)

Examples of more advanced configurations with explainations can be
found in the [examples](examples/) directory.
Examples of more advanced configurations with explainations can be found in the
[examples](examples/) directory in the source repository.

## Community

Expand All @@ -79,4 +75,4 @@ The code is under MIT license. See [LICENSE](LICENSE) for more information.
[dnsbl]: https://en.wikipedia.org/wiki/DNSBL
[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/
2 changes: 1 addition & 1 deletion dist/systemd/maddy.service
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Description=maddy mail server
Documentation=man:maddy(1)
Documentation=man:maddy.conf(5)
Documentation=https://github.com/foxcpp/maddy/wiki
Documentation=https://foxcpp.dev/maddy/
After=network.target

[Service]
Expand Down
3 changes: 3 additions & 0 deletions dist/systemd/[email protected]
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[Unit]
Description=maddy mail server (using %i.conf)
Documentation=man:maddy(1)
Documentation=man:maddy.conf(5)
Documentation=https://foxcpp.dev/maddy/
After=network.target

[Service]
Expand Down

0 comments on commit 5f809c3

Please sign in to comment.