Skip to content

Commit 45fe6aa

Browse files
committed
docs: update mkdocs conf
1 parent 9818c7d commit 45fe6aa

File tree

3 files changed

+153
-32
lines changed

3 files changed

+153
-32
lines changed

mkdocs.yml

Lines changed: 43 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,55 @@ site_name: Commitizen
22
site_description: commit rules, semantic version, conventional commits
33

44
theme:
5-
name: 'material'
5+
name: "material"
6+
palette:
7+
- primary: 'deep purple'
8+
# Palette toggle for automatic mode
9+
- media: "(prefers-color-scheme)"
10+
toggle:
11+
icon: material/brightness-auto
12+
name: Switch to light mode
13+
14+
# Palette toggle for light mode
15+
- media: "(prefers-color-scheme: light)"
16+
scheme: default
17+
toggle:
18+
icon: material/brightness-7
19+
name: Switch to dark mode
20+
21+
# Palette toggle for dark mode
22+
- media: "(prefers-color-scheme: dark)"
23+
scheme: slate
24+
toggle:
25+
icon: material/brightness-4
26+
name: Switch to system preference
627

728
repo_name: commitizen-tools/commitizen
829
repo_url: https://github.com/commitizen-tools/commitizen
930
edit_uri: ""
1031

1132
nav:
12-
- Introduction: 'README.md'
13-
- Getting Started: 'getting_started.md'
14-
- Commands:
15-
- Init: 'init.md'
16-
- Commit: 'commit.md'
17-
- Bump: 'bump.md'
18-
- Check: 'check.md'
19-
- Changelog: 'changelog.md'
20-
- Configuration: 'config.md'
21-
- Customization: 'customization.md'
22-
- Tutorials:
23-
- Writing commits: 'tutorials/writing_commits.md'
24-
- Auto check commits: 'tutorials/auto_check.md'
25-
- GitLab CI: 'tutorials/gitlab_ci.md'
26-
- Github Actions: 'tutorials/github_actions.md'
27-
- Jenkins pipeline: 'tutorials/jenkins_pipeline.md'
28-
- FAQ: 'faq.md'
29-
- Exit Codes: 'exit_codes.md'
30-
- Third-Party Commitizen Templates: 'third-party-commitizen.md'
31-
- Contributing: 'contributing.md'
32-
- Resources: 'external_links.md'
33+
- Introduction: "README.md"
34+
- Getting Started: "getting_started.md"
35+
- Commands:
36+
- Init: "init.md"
37+
- Commit: "commit.md"
38+
- Bump: "bump.md"
39+
- Check: "check.md"
40+
- Changelog: "changelog.md"
41+
- Configuration: "config.md"
42+
- Customization: "customization.md"
43+
- Tutorials:
44+
- Writing commits: "tutorials/writing_commits.md"
45+
- Auto check commits: "tutorials/auto_check.md"
46+
- GitLab CI: "tutorials/gitlab_ci.md"
47+
- Github Actions: "tutorials/github_actions.md"
48+
- Jenkins pipeline: "tutorials/jenkins_pipeline.md"
49+
- FAQ: "faq.md"
50+
- Exit Codes: "exit_codes.md"
51+
- Third-Party Commitizen Templates: "third-party-commitizen.md"
52+
- Contributing: "contributing.md"
53+
- Resources: "external_links.md"
3354

3455
markdown_extensions:
3556
- markdown.extensions.codehilite:

poetry.lock

Lines changed: 108 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ mypy = "^0.931"
6868
types-PyYAML = "^5.4.3"
6969
types-termcolor = "^0.1.1"
7070
# documentation
71-
mkdocs = "^1.0"
72-
mkdocs-material = "^8.5.11"
71+
mkdocs = "^1.4.2"
72+
mkdocs-material = "^9.1.6"
7373

7474

7575
[tool.poetry.scripts]

0 commit comments

Comments
 (0)