Overview
Community plugins
You can check out the Rspress plugins provided by the community at awesome-rstack - Rspress Plugins.
You can also discover more Rspress plugins on npm by searching for the keyword rspress-plugin.
Here are some community plugins:
- rspress-plugin-file-tree: Rspress plugin that add tree view for file structure display.
- rspress-plugin-gh-pages: Rspress plugin to add support for automatic deployment to GitHub Pages.
- rspress-plugin-translate: A plugin that integrates LLM for document translation.
- rspress-plugin-font-open-sans: Use Open Sans as the default font in your Rspress website.
- rspress-plugin-align-image: Rspress plugin to align images in markdown.
- rspress-plugin-directives: Rspress plugin for custom directives support.
- rspress-plugin-google-analytics: Rspress plugin for Google Analytics integration.
- rspress-plugin-vercel-analytics: Rspress plugin for Vercel 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 on-my-live2d.
- rspress-plugin-mermaid: Rspress plugin to render Mermaid diagrams in markdown files.
- rspress-plugin-reading-time: Rspress plugin to display reading time for your document pages.
- rspress-plugin-supersub: Rspress plugin to add superscript(
<super></super>) and subscript(<sub></sub>) support. - rspress-plugin-toc: Rspress plugin that injects a table of contents into the page.
- rspress-plugin-auto-meta: Rspress plugin to automatically generate navigation metadata for your documentation.
- rspress-plugin-map: Insert interactive maps into Rspress, inspired by hexo-tag-map.
- rspress-plugin-auto-sidebar: Automatically generate the sidebar from the navbar configuration.
- rspress-plugin-giscus: Integrate giscus into Rspress, a comment system powered by GitHub Discussions.
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.