Skip to content

Commit

Permalink
docs: add more community plugins (#953)
Browse files Browse the repository at this point in the history
  • Loading branch information
linbudu599 authored Apr 18, 2024
1 parent 0216755 commit 19cf589
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 342 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
["translate"]
[
"overview"
]
25 changes: 25 additions & 0 deletions packages/document/docs/en/plugin/community-plugins/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Overview

## Community Plugins

Community plugins include:

- [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/rspack-contrib/rspress-plugin-font-open-sans): Use Open Sans as the default font in your Rspress website.
Rspress website.
- [rspress-plugin-align-image](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-align-image): Rspress plugin to align images in markdown.
- [rspress-plugin-directives](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-directives): Rspress plugin for custom directives support.
- [rspress-plugin-file-tree](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-file-tree): Rspress plugin that add tree view for file structure display.
- [rspress-plugin-gh-pages](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-gh-pages): Rspress plugin to add support for automatic deployment to GitHub Pages.
- [rspress-plugin-google-analytics](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-google-analytics): Rspress plugin for Google Analytics integration.
- [rspress-plugin-vercel-analytics](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-vercel-analytics): Rspress plugin for Vercel Analytics integration.
- [rspress-plugin-katex](https://github.com/linbudu599/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/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-live2d): Rspress plugin for live2d, powered by [on-my-live2d](https://oml2d.com/).
- [rspress-plugin-mermaid](https://github.com/linbudu599/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/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-reading-time): Rspress plugin to display reading time for your document pages.
- [rspress-plugin-supersub](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-supersub): Rspress plugin to add superscript(`<super></super>`) and subscript(`<sub></sub>`) support.
- [rspress-plugin-toc](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-toc): Rspress plugin that injects a table of contents into the page.

You can check out the Rspress plugins provided by the community at [awesome-rspack - Rspress Plugins](https://github.com/web-infra-dev/awesome-rspack?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).
159 changes: 0 additions & 159 deletions packages/document/docs/en/plugin/community-plugins/translate.mdx

This file was deleted.

11 changes: 0 additions & 11 deletions packages/document/docs/en/plugin/official-plugins/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,3 @@ Official plugins include:
- [@rspress/plugin-playground](./playground): Provide a real-time playground to preview the code blocks in Markdown/MDX files.
- [@rspress/plugin-shiki](./shiki): Integrates [Shiki](https://github.com/shikijs/shiki) for code syntax highlighting.
- [@rspress/plugin-rss](./rss):Generate RSS files with [feed](https://github.com/jpmonette/feed) for the document site.

## Community Plugins

Community plugins include:

- [rspress-plugin-translate](../community-plugins/translate): A plugin that integrates LLM for document translation.
- [rspress-plugin-font-open-sans](https://github.com/rspack-contrib/rspress-plugin-font-open-sans): Use Open Sans as the default font in your Rspress website.

You can check out the Rspress plugins provided by the community at [awesome-rspack - Rspress Plugins](https://github.com/web-infra-dev/awesome-rspack?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).
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
["translate"]
[
"overview"
]
24 changes: 24 additions & 0 deletions packages/document/docs/zh/plugin/community-plugins/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 总览

## 社区插件

社区插件包括:

- [rspress-plugin-translate](https://github.com/byteHulk/rspress-plugin-translate):集成 LLM 进行文档翻译的插件。
- [rspress-plugin-font-open-sans](https://github.com/rspack-contrib/rspress-plugin-font-open-sans): 使用 Open Sans 作为 Rspress 网站中的默认字体。
- [rspress-plugin-align-image](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-align-image): 让 markdown 中的图片居中展示.
- [rspress-plugin-directives](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-directives): 支持自定义的指令到全局组件转换逻辑.
- [rspress-plugin-file-tree](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-file-tree): 支持文件树的可视化展示.
- [rspress-plugin-gh-pages](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-gh-pages): 自动部署到 GitHub Pages.
- [rspress-plugin-google-analytics](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-google-analytics): 为 Rspress 站点集成 Google Analytics.
- [rspress-plugin-vercel-analytics](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-vercel-analytics): 为 Rspress 站点集成 Vercel Analytics.
- [rspress-plugin-katex](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-katex): 支持在 markdown 中编写数学公式,并使用 [KaTeX](https://katex.org/) 渲染.
- [rspress-plugin-live2d](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-live2d): 为你的 Rspress 站点添加看板娘,基于 [on-my-live2d](https://oml2d.com/).
- [rspress-plugin-mermaid](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-mermaid): 为 Rspress 支持基于 [Mermaid](https://mermaid.js.org/#/) 的流程图、时序图等.
- [rspress-plugin-reading-time](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-reading-time): 计算每一页文档的预计阅读时间,并在文档的正上方展示.
- [rspress-plugin-supersub](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-supersub): 为 Rspress 支持 上标(`<super></super>`) 与 下标(`<sub></sub>`) 语法.
- [rspress-plugin-toc](https://github.com/linbudu599/rspress-plugins/tree/main/packages/rspress-plugin-toc): 自动为你的文档页面生成内容导航。

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

也可以在 npm 上搜索 [rspress-plugin](https://www.npmjs.com/search?q=rspress-plugin&ranking=popularity) 关键词来发现更多 Rspress 插件。
159 changes: 0 additions & 159 deletions packages/document/docs/zh/plugin/community-plugins/translate.mdx

This file was deleted.

Loading

0 comments on commit 19cf589

Please sign in to comment.