Modmail Guides

Appearance

Publish with Cloudflare Pages ​

This documentation is a VitePress static site and can be deployed with Cloudflare Pages.

Connect the project ​

  1. Push this repository to a Git provider supported by Cloudflare Pages.
  2. In the Cloudflare dashboard, create a Pages project and connect the repository.
  3. Set the Root directory to docs.
  4. Set the Build command to npm run build.
  5. Set the Build output directory to .vitepress/dist.
  6. Deploy the project.

Cloudflare Pages installs dependencies from docs/package-lock.json with npm ci. Commit that lockfile after running npm install in docs.

Build locally ​

From the docs directory:

sh
npm install
npm run dev

Build and preview the production output before publishing:

sh
npm run build
npm run preview

The generated site is written to docs/.vitepress/dist; do not edit generated files directly.

Use a custom domain ​

After the first successful deployment, add the desired hostname under the Pages project's Custom domains settings and follow Cloudflare's DNS instructions. The current content links to the existing docs.modmail.dev installation guide; coordinate the hostname before replacing or redirecting the existing docs site.