Plugin Configuration

Comprehensive configuration options for customizing the git revision date localized plugin behavior, including date display formats, localization settings, timezone handling, file exclusion patterns, and performance optimization.

Capabilities

Basic Configuration Options

Core settings that control the fundamental behavior of the plugin.

("enabled", config_options.Type(bool, default=True))
("type", config_options.Type(str, default="date"))
("locale", config_options.Type(str, default=None))
("timezone", config_options.Type(str, default="UTC"))
("strict", config_options.Type(bool, default=True))

Usage:

plugins:
  - git-revision-date-localized:
      enabled: true
      type: date
      locale: en
      timezone: UTC
      strict: true

Parameters:

• enabled: Enable or disable the plugin
• type: Date format type - "date", "datetime", "iso_date", "iso_datetime", "timeago", or "custom"
• locale: Language locale for date formatting (e.g., "en", "fr", "de")
• timezone: Timezone for date display (e.g., "UTC", "America/New_York")
• strict: Whether to treat warnings as errors when using mkdocs build --strict

Date Format Customization

Options for customizing how dates are displayed and formatted.

("custom_format", config_options.Type(str, default="%d. %B %Y"))
("fallback_to_build_date", config_options.Type(bool, default=False))

Usage:

plugins:
  - git-revision-date-localized:
      type: custom
      custom_format: "%B %d, %Y"
      fallback_to_build_date: true

Parameters:

• custom_format: strftime format string for custom date formatting
• fallback_to_build_date: Use build date when git information is unavailable

File Processing Options

Configure which files to process and how to handle git history.

("exclude", config_options.Type(list, default=[]))
("enable_git_follow", config_options.Type(bool, default=True))
("ignored_commits_file", config_options.Type(str, default=None))

Usage:

plugins:
  - git-revision-date-localized:
      exclude:
        - "drafts/*"
        - "*.tmp"
      enable_git_follow: true
      ignored_commits_file: ".git-blame-ignore-revs"

Parameters:

• exclude: List of glob patterns for files to exclude from processing
• enable_git_follow: Follow file renames in git history
• ignored_commits_file: Path to file containing commit hashes to ignore

Advanced Features

Optional features that enhance functionality but may impact performance.

("enable_creation_date", config_options.Type(bool, default=False))
("enable_parallel_processing", config_options.Type(bool, default=True))

Usage:

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
      enable_parallel_processing: true

Parameters:

• enable_creation_date: Also track and display file creation dates
• enable_parallel_processing: Use multiprocessing for better performance

Supported Date Types

The type configuration option supports these values:

• date: Long date format (e.g., "January 15, 2023")
• datetime: Date with time (e.g., "January 15, 2023 14:30:25")
• iso_date: ISO date format (e.g., "2023-01-15")
• iso_datetime: ISO datetime format (e.g., "2023-01-15 14:30:25")
• timeago: Relative time format (e.g., "2 days ago") using timeago.js
• custom: User-defined format using custom_format parameter

Configuration Examples

Multi-language Site

plugins:
  - git-revision-date-localized:
      type: date
      locale: fr
      timezone: Europe/Paris

Performance Optimized

plugins:
  - git-revision-date-localized:
      enable_parallel_processing: true
      exclude:
        - "generated/*"
        - "temp/*"

Development Environment

plugins:
  - git-revision-date-localized:
      fallback_to_build_date: true
      strict: false