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

# 总览

## 社区插件

你可以在 [awesome-rstack - Rspress Plugins](https://github.com/rstackjs/awesome-rstack?tab=readme-ov-file#rspress-plugins) 中查看社区提供的 Rspress 插件。

也可以在 npm 上搜索 [rspress-plugin](https://www.npmjs.com/search?q=rspress-plugin\&ranking=popularity) 关键词来发现更多 Rspress 插件。

下面是一些社区插件：

- [rspress-plugin-file-tree](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-file-tree): 支持文件树的可视化展示.
- [rspress-plugin-gh-pages](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-gh-pages): 自动部署到 GitHub Pages.
- [rspress-plugin-translate](https://github.com/byteHulk/rspress-plugin-translate)：集成 LLM 进行文档翻译的插件。
- [rspress-plugin-font-open-sans](https://github.com/rstackjs/rspress-plugin-font-open-sans): 使用 Open Sans 作为 Rspress 网站中的默认字体。
- [rspress-plugin-align-image](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-align-image): 让 markdown 中的图片居中展示.
- [rspress-plugin-directives](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-directives): 支持自定义的指令到全局组件转换逻辑.
- [rspress-plugin-google-analytics](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-google-analytics): 为 Rspress 站点集成 Google Analytics.
- [rspress-plugin-vercel-analytics](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-vercel-analytics): 为 Rspress 站点集成 Vercel Analytics.
- [rspress-plugin-katex](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-katex): 支持在 markdown 中编写数学公式，并使用 [KaTeX](https://katex.org/) 渲染.
- [rspress-plugin-live2d](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-live2d): 为你的 Rspress 站点添加看板娘，基于 [oh-my-live2d](https://oml2d.hacxy.cn/).
- [rspress-plugin-mermaid](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-mermaid): 为 Rspress 支持基于 [Mermaid](https://mermaid.js.org/#/) 的流程图、时序图等.
- [rspress-plugin-reading-time](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-reading-time): 计算每一页文档的预计阅读时间，并在文档的正上方展示.
- [rspress-plugin-supersub](https://github.com/rstackjs/rspress-plugins/tree/main/packages/rspress-plugin-supersub): 为 Rspress 支持 上标(`<super></super>`) 与 下标(`<sub></sub>`) 语法.
- [rspress-plugin-auto-meta](https://github.com/smileluck/rspress-plugin-auto-meta.git): 自动为您的文档生成导航元数据的 Rspress 插件。
- [rspress-plugin-map](https://github.com/buyfakett/rspress-plugin-map.git): 在 rspress 中插入交互式地图，灵感来自于 [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): 通过 navbar 自动生成生成 sidebar。
- [rspress-plugin-giscus](https://github.com/buyfakett/rspress-plugin-giscus.git): 集成 [giscus](https://github.com/giscus/giscus) 到 Rspress，一个基于 GitHub Discussions 的评论系统。
- [rspress-plugin-blog-list](https://github.com/buyfakett/rspress-plugin-blog-list.git): 集成博客列表到 Rspress。
- [rspress-plugin-pretext-breaker](https://github.com/y-lakhdar/rspress-plugin-pretext-breaker): 为你的 Rspress 站点添加 Pretext Breaker 游戏。
- [rspress-plugin-comments](https://github.com/kalicyh/rspress-plugin-comments): 为 Rspress 提供页面评论与文本选区评论，支持自托管后端和可选的 Gitea OAuth 登录。
- [rspress-plugin-typesense](https://github.com/typesense/rspress-plugin-typesense): 使用 [Typesense](https://typesense.org/)（一个开源、支持容错拼写的搜索引擎）替换 Rspress 内置搜索的插件。
- [rspress-plugin-viz](https://github.com/elecmonkey/rspress-plugin-viz): 为 Rspress 提供基于 [@viz-js/viz](https://github.com/mdaines/viz-js/) 的 Graphviz 图表渲染支持。
- [rspress-plugin-third-parties](https://github.com/sanjaiyan-dev/rspress-plugin-third-parties): 高性能、零配置的第三方脚本与嵌入内容加载插件，支持 Google Analytics、GTM、YouTube、Google Maps 和 Twitter/X，并针对 Core Web Vitals 进行优化。查看[官方文档与在线演示](https://sanjaiyan-dev.github.io/rspress-plugin-third-parties/)。

## 贡献社区插件

欢迎社区贡献 Rspress 插件！插件 npm 包名约定以 `rspress-plugin-` 开头。

你可以选择以下方式贡献：

- 在自己的仓库中开发并发布插件，然后提交 PR 将插件添加到本页面的社区插件列表中。
- 直接向 [rspress-plugins](https://github.com/rstackjs/rspress-plugins) 仓库贡献，该仓库中已有多个社区插件，可以作为参考。