Skip to content

naust-mail/naust-docs

Repository files navigation

Naust Docs

Source for naust.email, built with Fumadocs on Next.js. Serves both the homepage and the documentation under /docs.

Naust is a self-hosted email server: sending, receiving, spam filtering, DNS, TLS, calendars, contacts, and webmail, all under one admin panel. This repo holds the website and docs content - not the product itself, see naust-mail/naust.

Development

bun install
bun run dev

The site runs at http://localhost:3000. Docs content lives under content/docs/, written in MDX.

Build

bun run build

Outputs a static site to out/. Hosted on Vercel, which builds and deploys automatically on every push to main via its own git integration - no GitHub Actions deploy step.

Structure

  • content/docs/ - the documentation pages (MDX)
  • app/(home) - the naust.email homepage
  • app/docs - the /docs route and Fumadocs wiring
  • public/ - static assets

Contributing

Typo fixes and clarifications are welcome via PR. For larger structural changes (new sections, navigation changes), open an issue first to discuss.

License

MIT - see LICENSE.

About

The home of naust.email

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Contributors