Skip to content

Commit d5d1739

Browse files
committed
update
1 parent 181f9c8 commit d5d1739

1 file changed

Lines changed: 17 additions & 14 deletions

File tree

docs/content/docs/_index.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,7 @@ weight: 0
55

66
A minimal terminal email client for people who write in Markdown and live in Neovim.
77

8-
[Neomd](https://www.ssp.sh/brain/neomd/) is my way of implementing an email TUI based on my experience with Neomutt, focusing on [Neovim](https://www.ssp.sh/brain/neovim) (input) and reading/writing in [Markdown](https://www.ssp.sh/brain/markdown) and navigating with [Vim Motions](https://www.ssp.sh/brain/vim-language-and-motions) with the GTD workflow and [HEY-Screener](https://www.hey.com/features/the-screener/).
9-
10-
11-
{{< callout type="warning" >}}
12-
neomd moves, deletes, and modifies emails directly on your IMAP server. These operations affect your mailbox across all devices. **Back up important emails before first use.** neomd is experimental software and can't take responsibility for lost or misplaced emails. Consider testing with a secondary email account first.
13-
{{< /callout >}}
14-
8+
*Neomd is my way of implementing an email TUI based on my experience with Neomutt, focusing on [Neovim](https://www.ssp.sh/brain/neovim) (input) and reading/writing in [Markdown](https://www.ssp.sh/brain/markdown) and navigating with [Vim Motions](https://www.ssp.sh/brain/vim-language-and-motions) with the GTD workflow and [HEY-Screener](https://www.hey.com/features/the-screener/).*
159

1610
## The philosophy behind Neomd: What's unique?
1711

@@ -25,10 +19,6 @@ Also, we intentionally don't add more folders to the archive or file emails too,
2519

2620
But we have two additional **Feed** and **Papertrail**, two dedicated folders from HEY where you can read newsletters (just hit F) on them automatically in their separate tab, or move all your receipts into the Papertrail. Once you mark them as feed or papertrail, they will moved there automatically going forward. So you decide whether to read emails or news by jumping to different tabs.
2721

28-
{{< callout type="info" >}}
29-
neomd's **speed** depends entirely on your IMAP provider. On Hostpoint (the provider I use), a folder switch takes **~33ms** which feels instant. On Gmail, the same operation takes **~570ms** which is noticeably slow. See [Benchmark](#benchmark) for full details and how to test your provider.
30-
{{< /callout >}}
31-
3222

3323
### Email Processing Workflow
3424

@@ -82,10 +72,10 @@ flowchart TD
8272
*all colored boxes represent neomd folders*
8373

8474
**Key principles:**
85-
- **Screener first**: Unknown senders never clutter your Inbox — they wait in ToScreen for classification [[more](https://ssp-data.github.io/neomd/docs/screener/)]
75+
- **Screener first**: Unknown senders never clutter your Inbox, but get automatically wait in ToScreen for classification [[more](https://ssp-data.github.io/neomd/docs/screener/)]
8676
- **One-time decision**: Once you classify a sender (`I/O/F/P`), all future emails from them are automatically routed [[more](https://ssp-data.github.io/neomd/docs/screener/#how-classification-works)]
87-
- **GTD processing**: Emails in Inbox are processed once — if < 2 min, do it or keep it in inbox as doing *Next* otherwise move to Waiting, Someday, or Scheduled
88-
- **Minimal filing**: Only Archive when done; no complex folder hierarchies — use search to find old emails
77+
- **GTD processing**: Emails in Inbox are processed once. Inbox acting as want/need to do *Next*, otherwise move to Waiting, Someday, or Scheduled
78+
- **Minimal filing**: Only Archive when done; no complex folder hierarchies. Use search to find old emails
8979
- **Separate contexts**: Feed for newsletters (read when you want), PaperTrail for receipts (search when needed)
9080
- See full features list below.
9181

@@ -170,10 +160,20 @@ Or in Gmail:
170160
- **Kanagawa theme** — colors from the [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim) palette
171161
- **IMAP + SMTP** — direct connection via RFC 6851 MOVE, no local sync daemon required and keeps it in sync if you use it on mobile or different device [[more](https://ssp-data.github.io/neomd/docs/configuration/)]
172162

163+
{{< callout type="info" >}}
164+
neomd's **speed** depends entirely on your IMAP provider. On Hostpoint (the provider I use), a folder switch takes **~33ms** which feels instant. On Gmail, the same operation takes **~570ms** which is noticeably slow. See [Benchmark](#benchmark) for full details and how to test your provider.
165+
{{< /callout >}}
166+
167+
173168
## Install
174169

175170
**Prerequisites:** [Go 1.22+](https://go.dev/doc/install) and `make`.
176171

172+
{{< callout type="warning" >}}
173+
neomd moves, deletes, and modifies emails directly on your IMAP server. These operations affect your mailbox across all devices. **Back up important emails before first use.** neomd is experimental software and can't take responsibility for lost or misplaced emails. Consider testing with a secondary email account first.
174+
{{< /callout >}}
175+
176+
177177
{{< callout type="info" >}}
178178
**Optional attachment helpers:**
179179
- `yazi` enables the built-in file picker used by pre-send `a`
@@ -318,6 +318,9 @@ make help print this list
318318
- [goldmark](https://github.com/yuin/goldmark) — Markdown → HTML for sending
319319
- [BurntSushi/toml](https://github.com/BurntSushi/toml) — config parsing
320320

321+
322+
## FAQ
323+
You have more questions, check out the [docs](https://ssp-data.github.io/neomd/) with more information, or check [Frequently Asked Questions](https://ssp-data.github.io/neomd/docs/faq/).
321324
## Changelog
322325

323326
See [CHANGELOG.md](CHANGELOG.md) for what's new.

0 commit comments

Comments
 (0)