feat: add getPaginationPageTitle (#26)

* feat: prepare for configuring getPaginationPageTitle

* docs: add getPaginationPageTitle

Author: billyyyyy3320

docs/pagination/README.md

@@ -59,5 +59,28 @@ function getPaginationPageUrl(index) {
 - For [frontmatter classifier](../README.md#frontmatter-classifier), the `indexPath` defaults to `/${classifier.pid}/${classifier.id}` 
 (e.g. `/tag/js/`)
 
+## getPaginationPageTitle
+
+- Type: function
+- Default: `See Below`
+
+A function to get the title of pagination page dynamically:
+
+```js
+// directories
+function getPaginationPageTitle (index, id) {
+  return `Page ${index + 1} | ${id}`
+}
+
+// frontmatters
+function getPaginationPageTitle (index, id, scope) {
+  return `Page ${index + 1} - ${id} | ${scope}`
+}
+```
+
+There are three args to help you customize your title: 
+- `index` is the index of pages.
+- `id` is the id in the [config](../config/#id).
+- `scope` is the [key](../config/#keys) while configuring frontmatters or same as `id` while configuring directories.
 
 

src/node/handleOptions.ts

@@ -108,7 +108,7 @@ export function handleOptions(
      */
     paginations.push({
       classifierType: ClassifierTypeEnum.Directory,
-      getPaginationPageTitle(index) {
+      getPaginationPageTitle(index, id) {
         return `Page ${index + 1} | ${id}`
       },
       ...resolvePaginationConfig(

src/node/index.ts

@@ -106,8 +106,8 @@ module.exports = (options: BlogPluginOptions, ctx: VuePressContext) => {
 
               paginations.push({
                 classifierType: ClassifierTypeEnum.Frontmatter,
-                getPaginationPageTitle(index) {
-                  return `Page ${index + 1} - ${key} | ${scope}`
+                getPaginationPageTitle(index, id, scope) {
+                  return `Page ${index + 1} - ${id} | ${scope}`
                 },
                 ...resolvePaginationConfig(
                   ClassifierTypeEnum.Frontmatter,

src/node/interface/Pagination.ts

@@ -16,7 +16,7 @@ export type PageSorter = (
 ) => boolean | number
 
 export type GetPaginationPageUrl = (index: number) => string
-export type getPaginationPageTitle = (index: number) => string
+export type GetPaginationPageTitle = (index: number, id: string, scope: string) => string
 
 /**
  * Pagination config options for users.
@@ -45,7 +45,7 @@ export interface PaginationConfig {
   /**
    * A function to get the title of pagination page dynamically.
    */
-  getPaginationPageTitle?: getPaginationPageTitle;
+  getPaginationPageTitle?: GetPaginationPageTitle;
 }
 
 export interface PaginationIdentity {
@@ -64,7 +64,7 @@ export interface PaginationIdentity {
  */
 export interface InternalPagination
   extends PaginationConfig,
-    PaginationIdentity {
+  PaginationIdentity {
   /**
    * Record which classfier create this pagination.
    */

src/node/pagination.ts

@@ -3,7 +3,7 @@ import {
   InternalPagination,
   PageFilter,
   GetPaginationPageUrl,
-  getPaginationPageTitle,
+  GetPaginationPageTitle,
   SerializedPagination,
 } from './interface/Pagination'
 import { logPages } from './util'
@@ -82,7 +82,7 @@ export async function registerPaginations(
           permalink: path,
           frontmatter: {
             layout,
-            title: (getPaginationPageTitle as getPaginationPageTitle)(index),
+            title: (getPaginationPageTitle as GetPaginationPageTitle)(index, id, pid),
           },
           meta: {
             pid,