ESPresense.com

Source for https://espresense.com, the documentation site for ESPresense — an ESP32-based indoor positioning system.

Built with Astro and Starlight. Deployed to Cloudflare Pages from main.

Develop locally

You need Node 22 (see .nvmrc) and npm.

npm install
npm run dev

The site renders at http://localhost:4321 with hot reload.

Other scripts:

npm run build      # production build to ./dist
npm run preview    # serve the production build locally

Where pages live

• src/content/docs/ — Markdown (.md) and MDX (.mdx) pages.
• astro.config.mjs — sidebar layout and URL redirects.
• public/images/ — committed images (screenshots, diagrams).

Screenshots

The node web-UI screenshots in public/images/ (hardware_screen.png, network_screen.png) are captured from the firmware repo's UI, with every endpoint mocked, so no node is needed:

cd ../ESPresense/ui && npm run screenshots

It writes straight into this repo's public/images/ when the two repos are sibling checkouts. See ui/scripts/docs-screenshots.js in ESPresense/ESPresense.

Contributing

Read CONTRIBUTING-docs.md before opening a PR. It covers:

• Which Diataxis mode (tutorial / how-to / reference / explanation) fits which kind of page.
• The docs quality bar — verified commands, dated freshness lines, real diagrams, no abandoned drafts.
• How to submit a PR and what to expect on review.
• The voice we're aiming for.

For the firmware and the desktop daemon, see the upstream repos:

• Firmware: https://github.com/ESPresense/ESPresense
• Companion: https://github.com/ESPresense/ESPresense-companion

Questions: Discussions or Discord.