Skip to content

Commit 1ad3e03

Browse files
committed
Update configuration docs in README
1 parent d563fe6 commit 1ad3e03

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,24 @@ gems:
1919

2020
```yml
2121
jekyll-archives:
22-
layout: archive # The layout to use for archive pages.
23-
permalinks:
24-
year: '/archive/:name' # The permalink to use for year-based archives.
25-
tag: '/tag/:name' # The permalink to use for tag archives.
26-
category: '/category/:name' # The permalink to use for category archives.
22+
layout: archive # The default layout to use for archive pages.
23+
enabled: # Specifies which archives are enabled.
24+
- year
25+
- month
26+
- tags
27+
layouts: # (Optional) Specifies type-specific layouts.
28+
year: year-archive
29+
month: month-archive
30+
permalinks: # (Optional) The permalinks to use for each archive.
31+
year: '/:year/'
32+
month: '/:year/:month/'
33+
day: '/:year/:month/:day'
34+
tag: '/tag/:name/'
35+
category: '/category/:name/'
2736
```
37+
38+
### The `enabled` setting
39+
Archives are enabled based on the following configuration rules:
40+
- All archives are disabled by default.
41+
- All archives can be enabled by setting `enabled: true` or `enabled: all`.
42+
- Individual archives can be enabled by setting `enabled` to an array (see above example).

0 commit comments

Comments
 (0)