docs/Taskfile.yml at master · usetero/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
version: "3"

tasks:
  do:
    desc: "Fast development loop"
    aliases: ["d"]
    cmds:
      - task: format
      - task: lint

  dev:
    desc: "Start Mintlify dev server"
    cmds:
      - pnpm dev

  build:
    desc: "Build documentation"
    cmds:
      - pnpm build

  screenshots:
    desc: "Capture and embed screenshots from screenshot suggestions"
    cmds:
      - pnpm screenshots

  screenshots:dry:
    desc: "List screenshot suggestions without writing files"
    cmds:
      - pnpm screenshots:dry

  format:
    desc: "Format MDX files"
    cmds:
      - echo "Format task - add prettier when needed"

  check:
    desc: "Run all checks"
    cmds:
      - task: check:links

  check:links:
    desc: "Check for broken links (ignores .agents)"
    cmds:
      # mint broken-links has no exclude option, so strip .agents/ entries
      # from its report and fail only if other files have broken links
      - |
        out=$(pnpm exec mint broken-links 2>&1 || true)
        filtered=$(printf '%s\n' "$out" | awk '/^\.agents\//{skip=1;next} /^[^[:space:]]/{skip=0} !skip')
        if printf '%s\n' "$filtered" | grep -qE '^[^[:space:]].*\.(md|mdx)$'; then
          printf '%s\n' "$filtered"
          exit 1
        fi
        echo "No broken links found (excluding .agents)"

  lint:
    desc: "Lint documentation"
    cmds:
      - echo "Lint task - add vale or textlint when needed"

  install:
    desc: "Install dependencies"
    cmds:
      - pnpm install