> For AI agents: the complete documentation index is available at https://rspress.rs/llms.txt, the full documentation bundle is available at https://rspress.rs/llms-full.txt.

# Overview

## Community plugins

You can check out the Rspress plugins provided by the community at [awesome-rstack - Rspress Plugins](https://github.com/rstackjs/awesome-rstack?tab=readme-ov-file#rspress-plugins).

You can also discover more Rspress plugins on npm by searching for the keyword [rspress-plugin](https://www.npmjs.com/search?q=rspress-plugin\&ranking=popularity).

Here are some community plugins:

- [rspress-plugin-file-tree](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-file-tree): Rspress plugin that adds a tree view for displaying file structures.
- [rspress-plugin-gh-pages](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-gh-pages): Rspress plugin to add support for automatic deployment to GitHub Pages.
- [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/rstackjs/rspress-plugin-font-open-sans): Use Open Sans as the default font in your Rspress website.
- [rspress-plugin-align-image](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-align-image): Rspress plugin to align images in markdown.
- [rspress-plugin-directives](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-directives): Rspress plugin for custom directives support.
- [rspress-plugin-google-analytics](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-google-analytics): Rspress plugin for Google Analytics integration.
- [rspress-plugin-vercel-analytics](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-vercel-analytics): Rspress plugin for Vercel Analytics integration.
- [rspress-plugin-katex](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-katex): Rspress plugin to add support for rendering math equations using [KaTeX](https://katex.org/).
- [rspress-plugin-live2d](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-live2d): Rspress plugin for live2d, powered by [oh-my-live2d](https://oml2d.hacxy.cn/).
- [rspress-plugin-mermaid](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-mermaid): Rspress plugin to render [Mermaid](https://mermaid.js.org/#/) diagrams in markdown files.
- [rspress-plugin-reading-time](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-reading-time): Rspress plugin to display reading time for doc pages.
- [rspress-plugin-supersub](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-supersub): Rspress plugin to add superscript(`<super></super>`) and subscript(`<sub></sub>`) support.
- [rspress-plugin-auto-meta](https://github.com/smileluck/rspress-plugin-auto-meta.git): Rspress plugin to automatically generate navigation metadata for your documentation.
- [rspress-plugin-map](https://github.com/buyfakett/rspress-plugin-map.git): Insert interactive maps into Rspress, inspired by [hexo-tag-map](https://github.com/kuole-o/hexo-tag-map.git).
- [rspress-plugin-auto-sidebar](https://github.com/buyfakett/rspress-plugin-auto-sidebar.git): Automatically generate the sidebar from the navbar configuration.
- [rspress-plugin-giscus](https://github.com/buyfakett/rspress-plugin-giscus.git): Integrate [giscus](https://github.com/giscus/giscus) into Rspress, a comment system powered by GitHub Discussions.
- [rspress-plugin-blog-list](https://github.com/buyfakett/rspress-plugin-blog-list.git): Integrate blog list into Rspress.
- [rspress-plugin-pretext-breaker](https://github.com/y-lakhdar/rspress-plugin-pretext-breaker): Add the Pretext Breaker game to your Rspress site.
- [rspress-plugin-comments](https://github.com/kalicyh/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-typesense](https://github.com/typesense/rspress-plugin-typesense): Rspress plugin that replaces the built-in search with [Typesense](https://typesense.org/), an open-source, typo-tolerant search engine.
- [rspress-plugin-viz](https://github.com/elecmonkey/rspress-plugin-viz): Add Graphviz diagram rendering support for Rspress using [@viz-js/viz](https://github.com/mdaines/viz-js/).
- [rspress-plugin-third-parties](https://github.com/sanjaiyan-dev/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](https://sanjaiyan-dev.github.io/rspress-plugin-third-parties/).

## 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](https://github.com/rstackjs/rspress-plugins) repository, which already contains several community plugins that can serve as references.
