This repository contains the source code for the official Inboxt Documentation, built using VitePress.
Use this for real-time previewing with Hot Module Replacement (HMR) as you edit Markdown files.
npm install
npm run devThe site will be available at http://localhost:5173.
Use this to check the final static production build locally.
# Build the static site
npm run build
# Preview the build locally
npm run previewWe welcome improvements to Inboxt's documentation! Whether it's fixing a typo, improving a guide (self-hosting, local development, etc.), or documenting a core feature (saving articles, managing newsletters, or organizing content).
- Source files: All guides are located in the
docs/directory as Markdown files. - Config: The site structure and navigation are defined in
docs/.vitepress/config.mts.
This documentation is licensed under the MIT License.
The Inboxt application and backend are licensed separately under the AGPL-3.0. View the application repository.