0
# Plugin Configuration
1

2
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.
3

4
## Capabilities
5

6
### Basic Configuration Options
7

8
Core settings that control the fundamental behavior of the plugin.
9

10
```python { .api }
11
("enabled", config_options.Type(bool, default=True))
12
("type", config_options.Type(str, default="date"))
13
("locale", config_options.Type(str, default=None))
14
("timezone", config_options.Type(str, default="UTC"))
15
("strict", config_options.Type(bool, default=True))
16
```
17

18
**Usage:**
19

20
```yaml
21
plugins:
22
  - git-revision-date-localized:
23
      enabled: true
24
      type: date
25
      locale: en
26
      timezone: UTC
27
      strict: true
28
```
29

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

37
### Date Format Customization
38

39
Options for customizing how dates are displayed and formatted.
40

41
```python { .api }
42
("custom_format", config_options.Type(str, default="%d. %B %Y"))
43
("fallback_to_build_date", config_options.Type(bool, default=False))
44
```
45

46
**Usage:**
47

48
```yaml
49
plugins:
50
  - git-revision-date-localized:
51
      type: custom
52
      custom_format: "%B %d, %Y"
53
      fallback_to_build_date: true
54
```
55

56
**Parameters:**
57
- `custom_format`: strftime format string for custom date formatting
58
- `fallback_to_build_date`: Use build date when git information is unavailable
59

60
### File Processing Options
61

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

64
```python { .api }
65
("exclude", config_options.Type(list, default=[]))
66
("enable_git_follow", config_options.Type(bool, default=True))
67
("ignored_commits_file", config_options.Type(str, default=None))
68
```
69

70
**Usage:**
71

72
```yaml
73
plugins:
74
  - git-revision-date-localized:
75
      exclude:
76
        - "drafts/*"
77
        - "*.tmp"
78
      enable_git_follow: true
79
      ignored_commits_file: ".git-blame-ignore-revs"
80
```
81

82
**Parameters:**
83
- `exclude`: List of glob patterns for files to exclude from processing
84
- `enable_git_follow`: Follow file renames in git history
85
- `ignored_commits_file`: Path to file containing commit hashes to ignore
86

87
### Advanced Features
88

89
Optional features that enhance functionality but may impact performance.
90

91
```python { .api }
92
("enable_creation_date", config_options.Type(bool, default=False))
93
("enable_parallel_processing", config_options.Type(bool, default=True))
94
```
95

96
**Usage:**
97

98
```yaml
99
plugins:
100
  - git-revision-date-localized:
101
      enable_creation_date: true
102
      enable_parallel_processing: true
103
```
104

105
**Parameters:**
106
- `enable_creation_date`: Also track and display file creation dates
107
- `enable_parallel_processing`: Use multiprocessing for better performance
108

109
## Supported Date Types
110

111
The `type` configuration option supports these values:
112

113
- **date**: Long date format (e.g., "January 15, 2023")
114
- **datetime**: Date with time (e.g., "January 15, 2023 14:30:25")
115
- **iso_date**: ISO date format (e.g., "2023-01-15")
116
- **iso_datetime**: ISO datetime format (e.g., "2023-01-15 14:30:25")
117
- **timeago**: Relative time format (e.g., "2 days ago") using timeago.js
118
- **custom**: User-defined format using `custom_format` parameter
119

120
## Configuration Examples
121

122
### Multi-language Site
123

124
```yaml
125
plugins:
126
  - git-revision-date-localized:
127
      type: date
128
      locale: fr
129
      timezone: Europe/Paris
130
```
131

132
### Performance Optimized
133

134
```yaml
135
plugins:
136
  - git-revision-date-localized:
137
      enable_parallel_processing: true
138
      exclude:
139
        - "generated/*"
140
        - "temp/*"
141
```
142

143
### Development Environment
144

145
```yaml
146
plugins:
147
  - git-revision-date-localized:
148
      fallback_to_build_date: true
149
      strict: false
150
```