Skip to content

Commit

Permalink
Document ignore_case option
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasgeiter committed Dec 21, 2024
1 parent a6ee105 commit b3c0253
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,14 @@ This can be combined with `order` above.
sort_type: natural
```

### Sorting Case Sensitivity

Sorting is case-sensitive by default. To change that, set `ignore_case` to `true`.

```yaml
ignore_case: true
```

### Order Navigation By Preference

Create a file named `.pages` in a directory and set the `order_by` attribute to `filename` or `title` to change the order of navigation items.
Expand Down Expand Up @@ -393,6 +401,7 @@ plugins:
order: asc
sort_type: natural
order_by: title
ignore_case: true
```

### `filename`
Expand All @@ -412,7 +421,7 @@ Raise errors instead of warnings when:

Default is `true`

### `order`, `sort_type` and `order_by`
### `order`, `sort_type`, `ignore_case` and `order_by`

Global fallback values for the Meta attributes. Default is `None` or `filename`.

Expand Down

0 comments on commit b3c0253

Please sign in to comment.