The official documentation for NeoMutt, a terminal-based email client. Built with Sphinx and hosted on Read the Docs.
The guide follows the Di谩taxis documentation framework and is organised into four sections:
| Section | Description |
|---|---|
| Tutorials | Step-by-step lessons for newcomers (10 pages) |
| How-to guides | Task-oriented recipes for specific goals (62 pages) |
| Reference | Technical descriptions of configuration, commands, and functions (55 pages) |
| Explanation | Background discussion of concepts and design (14 pages) |
Source material was converted from the DocBook XML manual
(manual.xml) that ships with the NeoMutt source code.
Prerequisites: Python 3.10+ and pip.
# Install dependencies
pip install -r docs/requirements.txt
# Build HTML
make html
# Open in a browser
open build/html/index.html # macOS
xdg-open build/html/index.html # LinuxThe generated site is written to build/html/.
Contributions are welcome. Pages marked [TEMPLATE] contain outlines that need to be fleshed out, and pages with 馃摲 Screenshot Needed markers are waiting for terminal screenshots.
Please keep the Di谩taxis style conventions noted at the top of each page.
- NeoMutt website: https://neomutt.org
- NeoMutt source: https://github.com/neomutt/neomutt
- This documentation: https://github.com/neomutt/neomutt (
guidebranch)
This documentation is licensed under the GNU General Public License v2, the same license as NeoMutt itself.
