From cbe7e30c69e0fa04f7583c41b27bfd5a84384b72 Mon Sep 17 00:00:00 2001 From: neverland Date: Wed, 9 Oct 2024 12:00:30 +0800 Subject: [PATCH] docs: enable sitemap plugin --- .../en/plugin/community-plugins/overview.mdx | 1 + .../zh/plugin/community-plugins/overview.mdx | 1 + packages/document/package.json | 1 + packages/document/rspress.config.ts | 17 ++++++++++------- pnpm-lock.yaml | 7 +++++++ 5 files changed, 20 insertions(+), 7 deletions(-) diff --git a/packages/document/docs/en/plugin/community-plugins/overview.mdx b/packages/document/docs/en/plugin/community-plugins/overview.mdx index f9de92573..d6e79b59b 100644 --- a/packages/document/docs/en/plugin/community-plugins/overview.mdx +++ b/packages/document/docs/en/plugin/community-plugins/overview.mdx @@ -4,6 +4,7 @@ Community plugins include: +- [rspress-plugin-sitemap](https://github.com/jl917/rspress-plugin-sitemap): Automatically generate SEO-related sitemaps. - [rspress-plugin-translate](https://github.com/byteHulk/rspress-plugin-translate): A plugin that integrates LLM for document translation. - [rspress-plugin-font-open-sans](https://github.com/rspack-contrib/rspress-plugin-font-open-sans): Use Open Sans as the default font in your Rspress website. Rspress website. diff --git a/packages/document/docs/zh/plugin/community-plugins/overview.mdx b/packages/document/docs/zh/plugin/community-plugins/overview.mdx index dc48d4153..cf54913cc 100644 --- a/packages/document/docs/zh/plugin/community-plugins/overview.mdx +++ b/packages/document/docs/zh/plugin/community-plugins/overview.mdx @@ -4,6 +4,7 @@ 社区插件包括: +- [rspress-plugin-sitemap](https://github.com/jl917/rspress-plugin-sitemap)：自动生成用于 SEO 的站点地图。 - [rspress-plugin-translate](https://github.com/byteHulk/rspress-plugin-translate)：集成 LLM 进行文档翻译的插件。 - [rspress-plugin-font-open-sans](https://github.com/rspack-contrib/rspress-plugin-font-open-sans): 使用 Open Sans 作为 Rspress 网站中的默认字体。 - [rspress-plugin-align-image](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-align-image): 让 markdown 中的图片居中展示. diff --git a/packages/document/package.json b/packages/document/package.json index 82a4e8652..b30eea291 100644 --- a/packages/document/package.json +++ b/packages/document/package.json @@ -24,6 +24,7 @@ "rsbuild-plugin-open-graph": "^1.0.2", "rspress": "workspace:*", "rspress-plugin-font-open-sans": "^1.0.0", + "rspress-plugin-sitemap": "^1.1.1", "ts-node": "^10.9.2", "typescript": "^5.5.3" }, diff --git a/packages/document/rspress.config.ts b/packages/document/rspress.config.ts index 4778d164d..b6e22650e 100644 --- a/packages/document/rspress.config.ts +++ b/packages/document/rspress.config.ts @@ -1,8 +1,11 @@ import { pluginGoogleAnalytics } from 'rsbuild-plugin-google-analytics'; import { pluginOpenGraph } from 'rsbuild-plugin-open-graph'; import { pluginFontOpenSans } from 'rspress-plugin-font-open-sans'; +import pluginSitemap from 'rspress-plugin-sitemap'; import { defineConfig } from 'rspress/config'; +const siteUrl = 'https://rspress.dev'; + export default defineConfig({ root: 'docs', title: 'Rspress', @@ -20,7 +23,12 @@ export default defineConfig({ ssg: { strict: true, }, - plugins: [pluginFontOpenSans()], + plugins: [ + pluginFontOpenSans(), + pluginSitemap({ + domain: siteUrl, + }), + ], builderConfig: { dev: { lazyCompilation: true, @@ -30,7 +38,7 @@ export default defineConfig({ pluginOpenGraph({ title: 'Rspress', type: 'website', - url: 'https://rspress.dev/', + url: siteUrl, image: 'https://rspress.dev/og-image.png', description: 'Rspack based static site generator', twitter: { @@ -77,10 +85,6 @@ export default defineConfig({ 'https://github.com/web-infra-dev/rspress/tree/main/packages/document/docs', text: '📝 在 GitHub 上编辑此页', }, - prevPageText: '上一篇', - nextPageText: '下一篇', - outlineTitle: '目录', - searchPlaceholderText: '搜索', searchNoResultsText: '未搜索到相关结果', searchSuggestedQueryText: '可更换不同的关键字后重试', }, @@ -92,7 +96,6 @@ export default defineConfig({ 'https://github.com/web-infra-dev/rspress/tree/main/packages/document/docs', text: '📝 Edit this page on GitHub', }, - searchPlaceholderText: 'Search', }, ], }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 30e3e6e21..23b56e7a9 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -787,6 +787,9 @@ importers: rspress-plugin-font-open-sans: specifier: ^1.0.0 version: 1.0.0 + rspress-plugin-sitemap: + specifier: ^1.1.1 + version: 1.1.1 ts-node: specifier: ^10.9.2 version: 10.9.2(@types/node@18.11.17)(typescript@5.5.3) @@ -8980,6 +8983,10 @@ packages: resolution: {integrity: sha512-4GP0pd7h3W8EWdqE0VkA62nzUJZNy4ZnYK7be8+lOKHQKsQ5nZ+22A/VurNssi1eZFx3kjwbmIuoAkgb5W8S9Q==} dev: true + /rspress-plugin-sitemap@1.1.1: + resolution: {integrity: sha512-usb6zWoi5wFFmBeA9HKR6BhsnnsItudMBarc54GYpuRL55SWkLxyWyMijv14mUI04FI7J7lEmea08uZE0bVKxg==} + dev: true + /run-parallel@1.2.0: resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} dependencies: