blob: cc81126340c88806110f8ff3de0ea1a2651f8172 (
plain)
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
|
site_name: Gitlint
site_description: Linting for your git commit messages
site_url: https://jorisroovers.github.io/gitlint/latest
repo_url: https://github.com/jorisroovers/gitlint
repo_name: jorisroovers/gitlint
strict: true
edit_uri: edit/main/docs
markdown_extensions:
- admonition
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details # Collapsible admonitions
- tables
- toc:
permalink: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.snippets: # include files
auto_append:
- docs/includes/release-tags.md
- pymdownx.tabbed: # Tabbed code blocks
alternate_style: true
- pymdownx.emoji: # Enable emoji shortcodes
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
redirects:
redirect_maps:
# URLs present in the generated .gitlint file
contrib_rules.md : rules/contrib_rules.md
user_defined_rules.md : rules/user_defined_rules/index.md
mike:
alias_type: copy
canonical_version: latest
theme:
name: material
icon:
repo: fontawesome/brands/github
palette:
# 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 light mode
features:
- navigation.footer
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- content.code.annotate
- content.action.view
- content.action.edit
extra_css:
- stylesheets/termynal.css
- stylesheets/extra.css
extra_javascript:
- javascript/termynal.js
- javascript/extra.js
extra:
social:
- icon: simple/github
link: https://github.com/jorisroovers/gitlint
name: gitlint on github
- icon: simple/python
link: https://pypi.org/project/gitlint/
name: gitlint on PyPI
- icon: simple/docker
link: https://hub.docker.com/r/jorisroovers/gitlint
name: gitlint on dockerhub
- icon: material/web
link: https://jorisroovers.com
name: Joris Roovers personal website
- icon: simple/twitter
link: https://twitter.com/jorisroovers
name: Joris Roovers on twitter
version:
provider: mike
nav:
- Home:
- index.md # a top-level index.md (not in subdir) must exist for the homepage to work
- Getting Started:
- Quickstart: getting_started.md
- Installation: installation.md
- Using Gitlint:
- Commit hook Setup: commit_hooks.md
- CI Setup: ci.md
- Linting specific commits: linting_specific_commits.md
- Ignoring commits: ignoring_commits.md
- Exit Codes: exit_codes.md
- Alternatives: alternatives.md
- Configuration:
- Overview: configuration/index.md
- .gitlint file: configuration/gitlint_file.md
- Commandline config: configuration/cli.md
- Commit specific config: configuration/commit_config.md
- General Options: configuration/general_options.md
- Rules:
- Overview: rules/index.md
- Built-in Rules: rules/builtin_rules.md
- Contrib Rules: rules/contrib_rules.md
- Named Rules: rules/named_rules.md
- User Defined Rules:
- Getting Started: rules/user_defined_rules/index.md
- Line and Commit Rules: rules/user_defined_rules/line_and_commit_rules.md
- Configuration Rules: rules/user_defined_rules/configuration_rules.md
- Rule Violations: rules/user_defined_rules/violations.md
- Rule Options: rules/user_defined_rules/options.md
- Rule Specification: rules/user_defined_rules/rule_format_spec.md
- Contributing:
- Overview: contributing/index.md
- Environment Setup: contributing/environment_setup.md
- Tests, Formatting, Docs: contributing/tests_formatting_docs.md
- Packaging: contributing/packaging.md
- Releases: contributing/releases.md
- Contributing Contrib Rules: contributing/contrib_rules.md
- Changelog: https://github.com/jorisroovers/gitlint/blob/main/CHANGELOG.md
|
