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
|
site_name: Commitizen
site_description: commit rules, semantic version, conventional commits
theme:
name: "material"
palette:
- primary: 'deep purple'
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
repo_name: commitizen-tools/commitizen
repo_url: https://github.com/commitizen-tools/commitizen
edit_uri: ""
nav:
- Introduction: "README.md"
- Commands:
- init: "commands/init.md"
- commit: "commands/commit.md"
- bump: "commands/bump.md"
- check: "commands/check.md"
- changelog: "commands/changelog.md"
- example: "commands/example.md"
- info: "commands/info.md"
- ls: "commands/ls.md"
- schema: "commands/schema.md"
- version: "commands/version.md"
- Configuration:
- Configuration File: "config/configuration_file.md"
- Version Provider: "config/version_provider.md"
- bump: "config/bump.md"
- commit: "config/commit.md"
- check: "config/check.md"
- changelog: "config/changelog.md"
- Misc Options: "config/option.md"
- Advanced Customization:
- Configuration File: "customization/config_file.md"
- Customized Python Class: "customization/python_class.md"
- Changelog Template: "customization/changelog_template.md"
- Tutorials:
- Writing commits: "tutorials/writing_commits.md"
- Managing tags formats: "tutorials/tag_format.md"
- Auto check commits: "tutorials/auto_check.md"
- Auto prepare commit message: "tutorials/auto_prepare_commit_message.md"
- GitLab CI: "tutorials/gitlab_ci.md"
- GitHub Actions: "tutorials/github_actions.md"
- Jenkins pipeline: "tutorials/jenkins_pipeline.md"
- Developmental releases: "tutorials/dev_releases.md"
- Monorepo support: "tutorials/monorepo_guidance.md"
- FAQ: "faq.md"
- Features we won't add: "features_wont_add.md"
- Exit Codes: "exit_codes.md"
- Third-Party Commitizen Plugins:
- About: "third-party-plugins/about.md"
# Please sort the plugins alphabetically
- "third-party-plugins/commitizen-deno-provider.md"
- "third-party-plugins/commitizen-emoji.md"
- "third-party-plugins/conventional-jira.md"
- "third-party-plugins/cz-ai.md"
- "third-party-plugins/cz-conventional-gitmoji.md"
- "third-party-plugins/cz-emoji.md"
- "third-party-plugins/cz-legacy.md"
- "third-party-plugins/cz-path.md"
- "third-party-plugins/github-jira-conventional.md"
- Contributing: "contributing.md"
- Contributing TL;DR: "contributing_tldr.md"
- Resources: "external_links.md"
markdown_extensions:
- markdown.extensions.codehilite:
guess_lang: false
- admonition
- codehilite
- extra
- pymdownx.highlight
- pymdownx.superfences
- toc:
permalink: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
|
