Skip to content

Commit

Permalink
Merge branch 'lukasgeiter:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
lcvgit authored Dec 21, 2024
2 parents 8ad6f00 + 7b7e9c4 commit 818e30e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "mkdocs-awesome-pages-plugin"
version = "2.9.3"
version = "2.10.0"
description = "An MkDocs plugin that simplifies configuring page titles and their order"
authors = ["Lukas Geiter <info@lukasgeiter.com>"]
repository = "https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/"
Expand Down

0 comments on commit 818e30e

Please sign in to comment.