site_name: Commitizen
site_url: https://commitizen-tools.github.io/commitizen/
site_description: commit rules, semantic version, conventional commits

theme:
  name: material
  logo: images/cz_logo.png
  favicon: images/cz_logo.png
  palette:
    # 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
      primary: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      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:
    - Commit Message Best Practices: "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_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/contributing_tldr.md"
    - "contributing/contributing.md"
    - "contributing/pull_request.md"
  - "history.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

plugins:
  - search
  - git-revision-date-localized