This repository contains the VitePress site that powers the Dagu documentation. It includes guides, references, and workflow authoring tutorials for Dagu users.
- Node.js 20 or newer
- pnpm 9 or newer
- A current Dagu binary for validating embedded workflow examples
pnpm installpnpm devThis launches VitePress at http://localhost:5173 with hot-reload enabled.
pnpm build
pnpm previewpnpm build generates the static site into .vitepress/dist, and pnpm preview serves the built assets locally for final checks.
The validator prefers ../.local/bin/dagu when this repository sits beside a Dagu checkout. Otherwise it uses dagu from PATH. It checks the binary against the current workflow syntax before scanning every example, so an old binary fails with a short, useful error.
Set DAGU_BIN when the current build lives somewhere else:
DAGU_BIN=/path/to/current/dagu pnpm validate:examplesCI builds Dagu from the current main branch before running this check.
index.md: landing page for the documentation.overview/: high-level concepts, CLI, API, and project references.getting-started/: onboarding material for new Dagu users.features/: feature-focused guides.writing-workflows/: authoring workflows and best practices.step-types/: built-in step type references.web-ui/: Cockpit, workspace, operational pages, and REST API guides.server-admin/: server configuration, operations, authentication, and deployment guides.embedding/: embedded Dagu API and licensing notes.migration/: migration guides from other schedulers.public/: static assets served by VitePress.
Mermaid diagrams are supported via vitepress-plugin-mermaid; author diagrams by using fenced code blocks with the mermaid language tag.
- Fork or branch from
main. - Make documentation updates in Markdown (MDX is not enabled).
- Run
pnpm buildto ensure the site still compiles before opening a pull request.