Overview
Official plugins
Official plugins include:
- @rspress/plugin-algolia: Replace Rspress built-in search with Algolia based on DocSearch.
- @rspress/plugin-api-docgen: Integrate react-docgen-typescript and documentation, used to generate API document description automatically.
- @rspress/plugin-client-redirects: Support client redirects.
- @rspress/plugin-llms: Generate llms.txt related files for your Rspress site, allowing large language models to better understand your documentation site.
- @rspress/plugin-playground: Provide a real-time playground to preview the code blocks in Markdown/MDX files.
- @rspress/plugin-preview: Support preview of code blocks in Markdown/MDX.
- @rspress/plugin-rss: Generate RSS files with feed for the document site.
- @rspress/plugin-sitemap: Automatically generate sitemap for SEO, making it easier for search engines to crawl.
- @rspress/plugin-twoslash: Integrate Twoslash to automatically generate rich code blocks with type information.
- @rspress/plugin-typedoc: Integrate TypeDoc, used to generate API documentation of TS module automatically.