githooks/mkdocs.yml at master · Wtyd/githooks · 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
site_name: GitHooks
site_url: https://wtyd.github.io/githooks/
site_dir: public
site_description: >-
  Standalone CLI tool for managing git hooks and running QA tools in PHP projects.
  One config file. Every QA tool. Every git hook.
repo_url: https://github.com/Wtyd/githooks
repo_name: Wtyd/githooks
edit_uri: edit/master/docs/

copyright: Copyright &copy; 2024-2026 Wtyd/GitHooks contributors

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow

plugins:
  - search:
      lang: en

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

  # PyMdownx
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Wtyd/githooks
  generator: false

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Your First Config: getting-started/first-config.md
    - Running Your First Hook: getting-started/first-hook.md
  - Configuration:
    - configuration/index.md
    - Hooks: configuration/hooks.md
    - Flows: configuration/flows.md
    - Jobs: configuration/jobs.md
    - Options: configuration/options.md
    - Configuration File: configuration/file.md
  - Tools Reference:
    - tools/index.md
    - PHPStan: tools/phpstan.md
    - PHP CodeSniffer: tools/phpcs.md
    - PHP Mess Detector: tools/phpmd.md
    - PHPUnit: tools/phpunit.md
    - Paratest: tools/paratest.md
    - Psalm: tools/psalm.md
    - Parallel Lint: tools/parallel-lint.md
    - PHP Copy Paste Detector: tools/phpcpd.md
    - PHP CS Fixer: tools/phpcsfixer.md
    - Rector: tools/rector.md
    - Custom Jobs: tools/custom.md
  - Execution Modes: execution-modes.md
  - CLI Reference:
    - cli/index.md
    - githooks flow: cli/flow.md
    - githooks job: cli/job.md
    - githooks hook: cli/hook.md
    - githooks status: cli/status.md
    - githooks conf init: cli/conf-init.md
    - githooks conf check: cli/conf-check.md
    - githooks conf migrate: cli/conf-migrate.md
    - githooks cache clear: cli/cache-clear.md
    - githooks system info: cli/system-info.md
  - How-To Guides:
    - how-to/index.md
    - Parallel Execution & Thread Budget: how-to/parallel-execution.md
    - Conditional Hooks: how-to/conditional-hooks.md
    - CI/CD Integration: how-to/ci-cd.md
    - Frontend Tools: how-to/frontend-tools.md
    - Job Inheritance: how-to/job-inheritance.md
    - Output Formats: how-to/output-formats.md
    - Docker & Local Override: how-to/docker-local-override.md
    - Automating Hook Installation: how-to/automate-install.md
  - Migration:
    - migration/index.md
    - From v2 to v3: migration/v2-to-v3.md
    - From GrumPHP: migration/from-grumphp.md
    - From CaptainHook: migration/from-captainhook.md
  - Comparison: comparison.md
  - Changelog: changelog.md