Skip to content

Commit 9de5885

Browse files
committed
Fixed recommended year format string for blog plugin
1 parent fe32263 commit 9de5885

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

docs/schema/plugins/blog.json

+10-10
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@
5656
"oneOf": [
5757
{
5858
"enum": [
59-
"YYYY",
60-
"YYYY/MM",
61-
"YYYY/MM/dd"
59+
"yyyy",
60+
"yyyy/MM",
61+
"yyyy/MM/dd"
6262
]
6363
},
6464
{
6565
"type": "string"
6666
}
6767
],
68-
"default": "YYYY"
68+
"default": "yyyy"
6969
},
7070
"post_url_format": {
7171
"title": "Format string for post URLs",
@@ -149,31 +149,31 @@
149149
"oneOf": [
150150
{
151151
"enum": [
152-
"YYYY",
153-
"MMMM YYYY"
152+
"yyyy",
153+
"MMMM yyyy"
154154
]
155155
},
156156
{
157157
"type": "string"
158158
}
159159
],
160-
"default": "YYYY"
160+
"default": "yyyy"
161161
},
162162
"archive_url_date_format": {
163163
"title": "Format string for archive dates in URLs",
164164
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#+blog.archive_url_date_format",
165165
"oneOf": [
166166
{
167167
"enum": [
168-
"YYYY",
169-
"YYYY/MM"
168+
"yyyy",
169+
"yyyy/MM"
170170
]
171171
},
172172
{
173173
"type": "string"
174174
}
175175
],
176-
"default": "YYYY"
176+
"default": "yyyy"
177177
},
178178
"archive_url_format": {
179179
"title": "Format string for archive URLs",

docs/setup/setting-up-a-blog.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ The following configuration options are available for posts:
173173

174174
[`post_url_date_format`](#+blog.post_url_date_format){ #+blog.post_url_date_format }
175175

176-
: :octicons-milestone-24: Default: `YYYY/MM/dd` – This option specifies the
176+
: :octicons-milestone-24: Default: `yyyy/MM/dd` – This option specifies the
177177
date format that is used in the URL of the post. The format string must
178178
adhere to [Babel]'s [pattern syntax]. Some examples:
179179

@@ -182,23 +182,23 @@ The following configuration options are available for posts:
182182
``` yaml
183183
plugins:
184184
- blog:
185-
post_url_date_format: YYYY/MM/dd
185+
post_url_date_format: yyyy/MM/dd
186186
```
187187

188188
=== ":material-link: blog/2022/01/:material-dots-horizontal:/"
189189

190190
``` yaml
191191
plugins:
192192
- blog:
193-
post_url_date_format: YYYY/MM
193+
post_url_date_format: yyyy/MM
194194
```
195195

196196
=== ":material-link: blog/2022/:material-dots-horizontal:/"
197197

198198
``` yaml
199199
plugins:
200200
- blog:
201-
post_url_date_format: YYYY
201+
post_url_date_format: yyyy
202202
```
203203

204204
If you want to exclude the date altogether, e.g. when your blog features
@@ -368,7 +368,7 @@ The following configuration options are available for archive index generation:
368368

369369
[`archive_date_format`](#+blog.archive_date_format){ #+blog.archive_date_format }
370370

371-
: :octicons-milestone-24: Default: `YYYY` – This option specifies the date
371+
: :octicons-milestone-24: Default: `yyyy` – This option specifies the date
372372
format that is used when archive indexes are rendered. The format string
373373
must adhere to [Babel]'s [pattern syntax]. Popular settings are:
374374

@@ -377,20 +377,20 @@ The following configuration options are available for archive index generation:
377377
``` yaml
378378
plugins:
379379
- blog:
380-
archive_date_format: YYYY
380+
archive_date_format: yyyy
381381
```
382382

383383
=== "January 2022"
384384

385385
``` yaml
386386
plugins:
387387
- blog:
388-
archive_date_format: MMMM YYYY
388+
archive_date_format: MMMM yyyy
389389
```
390390

391391
[`archive_url_date_format`](#+blog.archive_url_date_format){ #+blog.archive_url_date_format }
392392

393-
: :octicons-milestone-24: Default: `YYYY` – This option specifies the date
393+
: :octicons-milestone-24: Default: `yyyy` – This option specifies the date
394394
format that is used in the archive index URL. The format string must adhere
395395
to [Babel]'s [pattern syntax]. Some examples:
396396

@@ -399,15 +399,15 @@ The following configuration options are available for archive index generation:
399399
``` yaml
400400
plugins:
401401
- blog:
402-
archive_url_date_format: YYYY
402+
archive_url_date_format: yyyy
403403
```
404404

405405
=== ":material-link: blog/archive/2022/01/"
406406

407407
``` yaml
408408
plugins:
409409
- blog:
410-
archive_url_date_format: YYYY/MM
410+
archive_url_date_format: yyyy/MM
411411
```
412412

413413
[`archive_url_format`](#+blog.archive_url_format){ #+blog.archive_url_format }

0 commit comments

Comments
 (0)