From 5aab527805be017c0beeec68a05cb16697a739b1 Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Sun, 6 Jan 2019 12:05:30 +0530 Subject: [PATCH] Improve documentation for this enhancement --- docs/advanced-usage.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index 13449b5..f03020d 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -139,11 +139,16 @@ Which will generate following canonical_url: ``` -### Changing title message for paginated page +### Customizing title modifier for paginated pages + +You can override the default title modifier for paginated pages from `Page %{current} of %{total} for ` to a string of your +choice by setting a `paginator_message` key in your `_config.yml`. -You can override default title message for paginated page from `Page %s of %s for ` to custom message by adding parameter to `_config.yml`. For example: + ```yml -paginator_message: "%s / %s |" +paginator_message: "%s / %s | " ``` -For key **paginator_message** please use string template with two variables `current` and `total`. \ No newline at end of file + +While the value can be any string text, we recommend using a Ruby string-template containing the variables `current` and `total` +similar to the example above, to incorporate the current page-number and total number of paginated pages in the title.