Overview
Community plugins
Community plugins are listed alphabetically by package name. We welcome PRs to add your published plugins to this list!
- @kazamori/rspress-plugin-git-diff: Shows the git history of documentation pages: changes marked on the page, a recent changes page, and the history of each page.
- @seshuk/rspress-plugin-scalar: Renders interactive Scalar API reference pages from OpenAPI specifications.
- rspress-language-tabs: An Rspress component for creating tabbed code examples with programming language icons.
- rspress-plugin-align-image: Rspress plugin to align images in markdown.
- rspress-plugin-annotation-words: An Rspress plugin to support annotation words.
- rspress-plugin-auto-meta: Rspress plugin to automatically generate navigation metadata for your documentation.
- rspress-plugin-auto-sidebar: Automatically generate the sidebar from the navbar configuration.
- rspress-plugin-blog-list: Integrate blog list into Rspress.
- rspress-plugin-changelog: Generates changelog pages, fetching release information from GitHub and GitLab repositories.
- rspress-plugin-clarity: Rspress plugin for Clarity integration.
- rspress-plugin-comments: Provide page comments and text selection comments for Rspress, with support for a self-hosted backend and optional Gitea OAuth login.
- rspress-plugin-directives: Rspress plugin for custom directives support.
- rspress-plugin-file-tree: Rspress plugin that adds a tree view for displaying file structures.
- rspress-plugin-font-figtree: Use Figtree as the default font in your Rspress website.
- rspress-plugin-font-open-sans: Use Open Sans as the default font in your Rspress website.
- rspress-plugin-gh-pages: Rspress plugin to add support for automatic deployment to GitHub Pages.
- rspress-plugin-giscus: Integrate giscus into Rspress, a comment system powered by GitHub Discussions.
- rspress-plugin-google-analytics: Rspress plugin for Google Analytics integration.
- rspress-plugin-katex: Rspress plugin to add support for rendering math equations using KaTeX.
- rspress-plugin-live2d: Rspress plugin for live2d, powered by oh-my-live2d.
- rspress-plugin-map: Insert interactive maps into Rspress, inspired by hexo-tag-map.
- rspress-plugin-mention-github: Mention GitHub users or add other links in Rspress.
- rspress-plugin-mermaid: Rspress plugin to render Mermaid diagrams in markdown files.
- rspress-plugin-pdf-generator: Generates multi-language single-page or multi-page PDF documents from Rspress site during build process.
- rspress-plugin-pinyin-search: Add Chinese full-pinyin and initial-letter search to Rspress's built-in local search.
- rspress-plugin-pretext-breaker: Add the Pretext Breaker game to your Rspress site.
- rspress-plugin-privatus: Rspress plugin that adds Privatus Analytics, cookieless website analytics, to every page.
- rspress-plugin-reading-time: Rspress plugin to display reading time for doc pages.
- rspress-plugin-remote-page: Load remote Markdown files (e.g. README.md) onto your website.
- rspress-plugin-shiki: Integrate Shiki and its transformers into Rspress.
- rspress-plugin-sitemap: Automatically generate SEO-related sitemaps.
- rspress-plugin-supersub: Rspress plugin to add superscript(
<super></super>) and subscript(<sub></sub>) support. - rspress-plugin-third-parties: High-performance, zero-config plugin for loading third-party scripts and embeds (Google Analytics, GTM, YouTube, Google Maps, Twitter/X) with maximum Core Web Vitals efficiency. Explore the Official Docs & Live Demos.
- rspress-plugin-translate: A plugin that integrates LLM for document translation.
- rspress-plugin-typesense: Rspress plugin that replaces the built-in search with Typesense, an open-source, typo-tolerant search engine.
- rspress-plugin-vercel-analytics: Rspress plugin for Vercel Analytics integration.
- rspress-plugin-viz: Add Graphviz diagram rendering support for Rspress using @viz-js/viz.
- zephyr-rspress-plugin: An Rspress plugin for deploying applications with Zephyr Cloud.
You can discover more Rspress plugins on npm by searching for the keyword rspress-plugin.
Contributing community plugins
Community contributions of Rspress plugins are welcome! Plugin npm package names should follow the rspress-plugin- prefix convention.
You can contribute in the following ways:
- Develop and publish a plugin in your own repository, then submit a PR to add it to the community plugins list on this page.
- Contribute directly to the rspress-plugins repository, which already contains several community plugins that can serve as references.