总览
社区插件
你可以在 awesome-rstack - Rspress Plugins 中查看社区提供的 Rspress 插件。
也可以在 npm 上搜索 rspress-plugin 关键词来发现更多 Rspress 插件。
下面是一些社区插件:
- rspress-plugin-file-tree: 支持文件树的可视化展示.
- rspress-plugin-gh-pages: 自动部署到 GitHub Pages.
- rspress-plugin-translate:集成 LLM 进行文档翻译的插件。
- rspress-plugin-font-open-sans: 使用 Open Sans 作为 Rspress 网站中的默认字体。
- rspress-plugin-align-image: 让 markdown 中的图片居中展示.
- rspress-plugin-directives: 支持自定义的指令到全局组件转换逻辑.
- rspress-plugin-google-analytics: 为 Rspress 站点集成 Google Analytics.
- rspress-plugin-vercel-analytics: 为 Rspress 站点集成 Vercel Analytics.
- rspress-plugin-katex: 支持在 markdown 中编写数学公式,并使用 KaTeX 渲染.
- rspress-plugin-live2d: 为你的 Rspress 站点添加看板娘,基于 on-my-live2d.
- rspress-plugin-mermaid: 为 Rspress 支持基于 Mermaid 的流程图、时序图等.
- rspress-plugin-reading-time: 计算每一页文档的预计阅读时间,并在文档的正上方展示.
- rspress-plugin-supersub: 为 Rspress 支持 上标(
<super></super>) 与 下标(<sub></sub>) 语法. - rspress-plugin-toc: 自动为你的文档页面生成内容导航。
- rspress-plugin-auto-meta: 自动为您的文档生成导航元数据的 Rspress 插件。
- rspress-plugin-map: 在 rspress 中插入交互式地图,灵感来自于 hexo-tag-map。
- rspress-plugin-auto-sidebar: 通过 navbar 自动生成生成 sidebar。
- rspress-plugin-giscus: 集成 giscus 到 Rspress,一个基于 GitHub Discussions 的评论系统。
贡献社区插件
欢迎社区贡献 Rspress 插件!插件 npm 包名约定以 rspress-plugin- 开头。
你可以选择以下方式贡献:
- 在自己的仓库中开发并发布插件,然后提交 PR 将插件添加到本页面的社区插件列表中。
- 直接向 rspress-plugins 仓库贡献,该仓库中已有多个社区插件,可以作为参考。