From 98d1fcbe54f8cbfd4eeea3d5d3db0f1c858da2e4 Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Fri, 9 Feb 2024 08:00:16 +0200 Subject: [PATCH] add website mentions of pageBasePath --- website/docs/advanced/routing.mdx | 1 + website/docs/api/plugins/plugin-content-blog.mdx | 1 + 2 files changed, 2 insertions(+) diff --git a/website/docs/advanced/routing.mdx b/website/docs/advanced/routing.mdx index e9e96d4892..7acc45ab6f 100644 --- a/website/docs/advanced/routing.mdx +++ b/website/docs/advanced/routing.mdx @@ -53,6 +53,7 @@ The component used for Markdown pages is `@theme/MDXPage`. React pages are direc The blog creates the following routes: - **Posts list pages**: `/`, `/page/2`, `/page/3`... + - The route is customizable through the `pageBasePath` option. - The component is `@theme/BlogListPage`. - **Post pages**: `/2021/11/21/algolia-docsearch-migration`, `/2021/05/12/announcing-docusaurus-two-beta`... - Generated from each Markdown post. diff --git a/website/docs/api/plugins/plugin-content-blog.mdx b/website/docs/api/plugins/plugin-content-blog.mdx index 41a90b4058..ece8fed6a0 100644 --- a/website/docs/api/plugins/plugin-content-blog.mdx +++ b/website/docs/api/plugins/plugin-content-blog.mdx @@ -48,6 +48,7 @@ Accepted fields: | `blogSidebarTitle` | `string` | `'Recent posts'` | Title of the blog sidebar. | | `routeBasePath` | `string` | `'blog'` | URL route for the blog section of your site. **DO NOT** include a trailing slash. Use `/` to put the blog at root path. | | `tagsBasePath` | `string` | `'tags'` | URL route for the tags section of your blog. Will be appended to `routeBasePath`. **DO NOT** include a trailing slash. | +| `pageBasePath` | `string` | `'page'` | URL route for the pages section of your blog. Will be appended to `routeBasePath`. **DO NOT** include a trailing slash. | | `archiveBasePath` | string \| null | `'archive'` | URL route for the archive section of your blog. Will be appended to `routeBasePath`. **DO NOT** include a trailing slash. Use `null` to disable generation of archive. | | `include` | `string[]` | `['**/*.{md,mdx}']` | Array of glob patterns matching Markdown files to be built, relative to the content path. | | `exclude` | `string[]` | _See example configuration_ | Array of glob patterns matching Markdown files to be excluded. Serves as refinement based on the `include` option. |