Skip to content

Commit d62821f

Browse files
committed
fix links
1 parent ad08a2f commit d62821f

11 files changed

Lines changed: 35 additions & 31 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Keep your inbox clean without effort.
150150
- **Auto-screen on load** — screener runs automatically every time the Inbox loads (startup, `R`); keeps your inbox clean without pressing `S` (configurable, on by default) [](https://neomd.ssp.sh/docs/screener/#auto-screen-and-background-sync)
151151
- **Whole-domain screening** — list entries beginning with `@` (e.g. `@ssp.sh`) match every address at that domain; per-address entries always win over a domain rule so a single blocked address inside an otherwise-approved domain stays blocked; press `Di` / `Do` to append `@<domain>` to your lists with a `y/n` confirm [](https://neomd.ssp.sh/docs/screener/#domain-entries)
152152
- **Background sync** — while neomd is open, inbox is fetched and screened every 5 minutes in the background; interval configurable, set to `0` to disable [](https://neomd.ssp.sh/docs/screener/#auto-screen-and-background-sync)
153-
- **Headless daemon mode** — run `neomd --headless` on a server to continuously screen emails without the TUI; watches screener list files for changes via Syncthing; perfect for running on a NAS while using the TUI on laptop/Android [](https://neomd.ssp.sh/docs/configurations/headless/)
153+
- **Headless daemon mode** — run `neomd --headless` on a server to continuously screen emails without the TUI; watches screener list files for changes via Syncthing; perfect for running on a NAS while using the TUI on laptop/Android [](https://neomd.ssp.sh/docs/configuration/headless/)
154154
- **Desktop notifications for VIP senders** — opt-in `[notifications]` block fires `notify-send` only for senders/domains you list in `notify.txt`; independent of screener categories; first run silently records a baseline so you don't get flooded [](https://neomd.ssp.sh/docs/notifications/)
155155
- **Folder tabs** — Inbox, ToScreen, Feed, PaperTrail, Archive, Waiting, Someday, Scheduled, Sent, Trash, ScreenedOut [](https://neomd.ssp.sh/docs/keybindings/#folders)
156156

@@ -185,7 +185,7 @@ Keep your inbox clean without effort.
185185
### Under the Hood
186186

187187
- **IMAP + SMTP** — direct connection via RFC 6851 MOVE, no local sync daemon required; stays in sync if you use it on mobile or different device [](https://neomd.ssp.sh/docs/configuration/)
188-
- **RFC 5322 compliant email delivery** — Message-IDs use sender's domain, proper MIME multipart/alternative structure (text/plain before text/html), quoted-printable encoding, and all required headers; ensures deliverability across all providers, spam filter compatibility, and correct email threading [](https://neomd.ssp.sh/docs/configurations/email-standards/)
188+
- **RFC 5322 compliant email delivery** — Message-IDs use sender's domain, proper MIME multipart/alternative structure (text/plain before text/html), quoted-printable encoding, and all required headers; ensures deliverability across all providers, spam filter compatibility, and correct email threading [](https://neomd.ssp.sh/docs/configuration/email-standards/)
189189
- **Kanagawa theme** — colors from the [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim) palette
190190

191191
> [!NOTE]
@@ -225,12 +225,12 @@ yay -S neomd-bin
225225

226226
On first run, neomd:
227227
1. Creates `~/.config/neomd/config.toml` with placeholders — fill in your IMAP/SMTP credentials
228-
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/content/docs/configurations/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
228+
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/content/docs/configuration/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
229229
2. Creates `~/.config/neomd/lists/` for screener allowlists (or uses your custom paths from config)
230230
3. Creates any missing IMAP folders (ToScreen, Feed, PaperTrail, etc.) automatically
231231

232232

233-
Neomd also runs on Android (more for fun) — see [docs/content/docs/configurations/android.md](docs/content/docs/android.md).
233+
Neomd also runs on Android (more for fun) — see [docs/content/docs/configuration/android.md](docs/content/docs/android.md).
234234

235235
## Configuration
236236

@@ -260,11 +260,11 @@ spam = "~/.config/neomd/lists/spam.txt"
260260

261261
Use an app-specific password (Gmail, Fastmail, Hostpoint, etc.) rather than your main account password. The `password` and `user` fields support environment variable expansion (`$VAR` or `${VAR}`) so you can avoid storing secrets in the config file.
262262

263-
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/content/docs/configuration.md](docs/content/docs/configuration.md).
263+
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/content/docs/configuration](docs/content/docs/configuration/_index.md).
264264

265265
**Provider-specific guides:**
266-
- Gmail: [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) — folder name mapping and OAuth2 setup
267-
- Proton Mail Bridge: [docs/content/docs/configurations/proton-bridge.md](docs/content/docs/configurations/proton-bridge.md) — non-standard port configuration
266+
- Gmail: [docs/content/docs/configuration/gmail.md](docs/content/docs/configuration/gmail.md) — folder name mapping and OAuth2 setup
267+
- Proton Mail Bridge: [docs/content/docs/configuration/proton-bridge.md](docs/content/docs/configuration/proton-bridge.md) — non-standard port configuration
268268

269269
### Onboarding
270270

@@ -375,7 +375,7 @@ Interestingly, Gmail benchmarks fast on a **fresh single connection** (`scripts/
375375

376376

377377
> [!NOTE]
378-
> **Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) for Gmail-specific folder configuration.
378+
> **Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/content/docs/configuration/gmail.md](docs/content/docs/configuration/gmail.md) for Gmail-specific folder configuration.
379379
380380
**Test your own provider:**
381381
```bash

docs/content/docs/_index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ Keep your inbox clean without effort.
153153
- **Auto-screen on load** — screener runs automatically every time the Inbox loads (startup, `R`); keeps your inbox clean without pressing `S` (configurable, on by default) [](https://neomd.ssp.sh/docs/screener/#auto-screen-and-background-sync)
154154
- **Whole-domain screening** — list entries beginning with `@` (e.g. `@ssp.sh`) match every address at that domain; per-address entries always win over a domain rule so a single blocked address inside an otherwise-approved domain stays blocked; press `Di` / `Do` to append `@<domain>` to your lists with a `y/n` confirm [](https://neomd.ssp.sh/docs/screener/#domain-entries)
155155
- **Background sync** — while neomd is open, inbox is fetched and screened every 5 minutes in the background; interval configurable, set to `0` to disable [](https://neomd.ssp.sh/docs/screener/#auto-screen-and-background-sync)
156-
- **Headless daemon mode** — run `neomd --headless` on a server to continuously screen emails without the TUI; watches screener list files for changes via Syncthing; perfect for running on a NAS while using the TUI on laptop/Android [](https://neomd.ssp.sh/docs/configurations/headless/)
156+
- **Headless daemon mode** — run `neomd --headless` on a server to continuously screen emails without the TUI; watches screener list files for changes via Syncthing; perfect for running on a NAS while using the TUI on laptop/Android [](https://neomd.ssp.sh/docs/configuration/headless/)
157157
- **Desktop notifications for VIP senders** — opt-in `[notifications]` block fires `notify-send` only for senders/domains you list in `notify.txt`; independent of screener categories; first run silently records a baseline so you don't get flooded [](https://neomd.ssp.sh/docs/notifications/)
158158
- **Folder tabs** — Inbox, ToScreen, Feed, PaperTrail, Archive, Waiting, Someday, Scheduled, Sent, Trash, ScreenedOut [](https://neomd.ssp.sh/docs/keybindings/#folders)
159159

@@ -188,7 +188,7 @@ Keep your inbox clean without effort.
188188
### Under the Hood
189189

190190
- **IMAP + SMTP** — direct connection via RFC 6851 MOVE, no local sync daemon required; stays in sync if you use it on mobile or different device [](https://neomd.ssp.sh/docs/configuration/)
191-
- **RFC 5322 compliant email delivery** — Message-IDs use sender's domain, proper MIME multipart/alternative structure (text/plain before text/html), quoted-printable encoding, and all required headers; ensures deliverability across all providers, spam filter compatibility, and correct email threading [](https://neomd.ssp.sh/docs/configurations/email-standards/)
191+
- **RFC 5322 compliant email delivery** — Message-IDs use sender's domain, proper MIME multipart/alternative structure (text/plain before text/html), quoted-printable encoding, and all required headers; ensures deliverability across all providers, spam filter compatibility, and correct email threading [](https://neomd.ssp.sh/docs/configuration/email-standards/)
192192
- **Kanagawa theme** — colors from the [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim) palette
193193

194194
{{< callout type="info" >}}
@@ -234,12 +234,12 @@ yay -S neomd-bin
234234

235235
On first run, neomd:
236236
1. Creates `~/.config/neomd/config.toml` with placeholders — fill in your IMAP/SMTP credentials
237-
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/content/docs/configurations/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
237+
- Important: Make sure that the Capitalization and naming of folder in `config.toml` is accroding to webmail IMAP, e.g. [Gmails](docs/content/docs/configuration/gmail.md) uses `sent = "[Gmail]/Sent Mail"` and not `sent` etc.
238238
2. Creates `~/.config/neomd/lists/` for screener allowlists (or uses your custom paths from config)
239239
3. Creates any missing IMAP folders (ToScreen, Feed, PaperTrail, etc.) automatically
240240

241241

242-
Neomd also runs on Android (more for fun) — see [docs/content/docs/configurations/android.md](docs/content/configurations/android).
242+
Neomd also runs on Android (more for fun) — see [docs/content/docs/configuration/android.md](docs/content/configuration/android).
243243

244244
## Configuration
245245

@@ -269,11 +269,11 @@ spam = "~/.config/neomd/lists/spam.txt"
269269

270270
Use an app-specific password (Gmail, Fastmail, Hostpoint, etc.) rather than your main account password. The `password` and `user` fields support environment variable expansion (`$VAR` or `${VAR}`) so you can avoid storing secrets in the config file.
271271

272-
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/content/configuration](docs/content/configuration).
272+
For the full configuration reference including multiple accounts, OAuth2 authentication, `[[senders]]` aliases, folder customization, signatures, and UI options, see [docs/content/docs/configuration](docs/content/docs/configuration/_index.md).
273273

274274
**Provider-specific guides:**
275-
- Gmail: [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) — folder name mapping and OAuth2 setup
276-
- Proton Mail Bridge: [docs/content/docs/configurations/proton-bridge.md](docs/content/docs/configurations/proton-bridge.md) — non-standard port configuration
275+
- Gmail: [docs/content/docs/configuration/gmail.md](docs/content/docs/configuration/gmail.md) — folder name mapping and OAuth2 setup
276+
- Proton Mail Bridge: [docs/content/docs/configuration/proton-bridge.md](docs/content/docs/configuration/proton-bridge.md) — non-standard port configuration
277277

278278
### Onboarding
279279

@@ -388,7 +388,7 @@ Interestingly, Gmail benchmarks fast on a **fresh single connection** (`scripts/
388388

389389

390390
{{< callout type="info" >}}
391-
**Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/content/docs/configurations/gmail.md](docs/content/docs/configurations/gmail.md) for Gmail-specific folder configuration.
391+
**Gmail is not recommended.** If you're on Gmail, consider a dedicated email provider (Hostpoint, Fastmail, HEY, Migadu, etc.) for the best neomd experience. Or use Gmail just for fun :). See [docs/content/docs/configuration/gmail.md](docs/content/docs/configuration/gmail.md) for Gmail-specific folder configuration.
392392
{{< /callout >}}
393393

394394

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2-
title: Configuration Reference
2+
title: Configurations
33
weight: 1
4+
sidebar:
5+
open: false
46
---
57

68
On first run, neomd creates `~/.config/neomd/config.toml` with placeholders.
@@ -88,7 +90,7 @@ Connect: [LinkedIn](https://example.com/)
8890

8991

9092
{{< callout type="info" >}}
91-
**Gmail** uses different IMAP folder names (`[Gmail]/Sent Mail`, `[Gmail]/Trash`, etc.). See [Gmail Configuration](configurations/gmail) for the correct mapping.
93+
**Gmail** uses different IMAP folder names (`[Gmail]/Sent Mail`, `[Gmail]/Trash`, etc.). See [Gmail Configuration](gmail/) for the correct mapping.
9294
{{< /callout >}}
9395

9496
Use an app-specific password (Gmail, Fastmail, Hostpoint, etc.) rather than your main account password.
@@ -152,7 +154,7 @@ smtp = "mail.custom.com:2587"
152154
starttls = true # Forces STARTTLS instead of TLS
153155
```
154156

155-
See [Proton Bridge Setup](configurations/proton-bridge) for complete Proton Mail Bridge setup instructions.
157+
See [Proton Bridge Setup](proton-bridge) for complete Proton Mail Bridge setup instructions.
156158

157159
For localhost/self-signed bridges such as Proton Mail Bridge, neomd first tries
158160
normal certificate verification. If that fails with an unknown-authority error
@@ -286,3 +288,13 @@ The scopes required depends on the provider and is better confirmed by your emai
286288

287289
- To enable OAuth2 authentication for Office365 accounts, follow the documentation [here](https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth)
288290
- For GMAIL, follow the documentation [here](https://developers.google.com/workspace/gmail/imap/xoauth2-protocol)
291+
292+
293+
## Dedicated Platforms
294+
295+
296+
- [Gmail Configuration](gmail/)
297+
- [Proton Mail Bridge](proton-bridge/)
298+
- [Android (Termux)](android/)
299+
- [Headless Daemon Mode](headless/)
300+
- [Email Standards](email-standards/)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/content/docs/configurations/_index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/content/docs/screener.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ This makes impersonation attempts easy to spot: if you've already screened in `i
9494

9595
Emails are only auto-screened while they are in the **Inbox**. Once moved to ToScreen (or any other folder), they are not re-classified automatically. This keeps the logic simple and predictable.
9696

97-
If emails end up in ToScreen incorrectly (e.g. screened by another device like [Termux with Android](configurations/android) with incomplete lists), use `:reset-toscreen` to move them back to Inbox where auto-screen will re-classify them.
97+
If emails end up in ToScreen incorrectly (e.g. screened by another device like [Termux with Android](configuration/android) with incomplete lists), use `:reset-toscreen` to move them back to Inbox where auto-screen will re-classify them.
9898

9999
## Colon commands
100100

0 commit comments

Comments
 (0)