VitePress template

The DockIY VitePress template is a documentation site starter that builds to static files and deploys behind Caddy and Traefik.

Stack

• VitePress
• Vue
• Docker Compose
• Caddy
• Traefik

The production image contains the generated site, but not the source code or JavaScript runtime.

Requirements

Install these tools on your computer:

• Node.js 24+
• pnpm 11+
• Git
• Docker Engine and Docker Compose
• the DockIY CLI for deployment

Develop locally

Create a project from the template:

dockiy app init vitepress my-docs
cd my-docs
pnpm install --frozen-lockfile
pnpm dev

You can also clone or fork the template directly. Edit the Markdown pages, .vitepress/config.mts, and files under public/. Check the production build before deploying:

pnpm build
pnpm preview

Configure deployment

The DockIY base stack must already be running. Edit dockiy.yml in the project root and set the application name and public hostname:

name: my-docs

environments:
  default:
    host: docs.example.com
    compose_file: docker-compose.yml

Set the VPS connection in the global DockIY config. For a checkout-specific override, create an uncommitted dockiy.config.yml in the project root. See the configuration reference for the config file locations and precedence.

The template's docker-compose.yml and files under scripts/ are already wired for deployment. Edit them only when changing the container or deployment behavior.

Deploy

Commit the application, then follow Deploying applications for the deployment, status, version, and rollback commands:

git add .
git commit -m "feat: configure application"
dockiy app deploy --version v1.0.0