Skip to content

Commit c59b81a

Browse files
ibradosverrirs
authored andcommitted
Add info re special characters and slugify
1 parent 2b24206 commit c59b81a

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README-AUTOPAGES.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,35 @@ If you have category or tag names with spaces, make sure you use either
107107
108108
See [Filtering categories](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#filtering-categories) for more information.
109109
110+
### Special characters
111+
112+
As of v1.9.4, special characters are supported in category, tag, and collection names by default:
113+
114+
``` yml
115+
category: sports car, b+w
116+
```
117+
118+
If you need to support the previous behavior where special characters are replaced with hyphens in URLs, use the new `slugify` option:
119+
120+
``` yml
121+
autopages:
122+
categories:
123+
enabled: true
124+
slugify:
125+
mode: nil
126+
cased: true
127+
```
128+
129+
The following modes are available:
130+
131+
| Value| Description |
132+
| --- | --- |
133+
| `none` | No conversion (default) |
134+
| `raw` | Replace sequences of spaces with a hyphen |
135+
| `nil` | Replace non-alphabetic characters with a hyphen |
136+
| `pretty` | Keep some non-alphabetic characters (._~!$&'()+,;=@) |
137+
138+
If `cased` is set to `true`, all uppercase letters are replaced with their lowercase counterparts.
139+
110140
## Common issues
111141
_None reported so far_

0 commit comments

Comments
 (0)