From 4f8f1796307183dc51a75b7f0ad7d980a083eecf Mon Sep 17 00:00:00 2001 From: linbudu Date: Wed, 24 Apr 2024 20:13:41 +0800 Subject: [PATCH] docs: update documentation --- README.md | 37 ++----------------------------------- 1 file changed, 2 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 7368b5e..5c65908 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,3 @@ -# Rspress Plugins +# SSG Framework Plugins -A collection of plugins to extend the capabilities of [rspress](https://rspress.dev/). - -## Plugin List - -### Syntax - -- [rspress-plugin-supersub](./packages/rspress-plugin-supersub), superscript and subscript syntax support. -- [rspress-plugin-katex](./packages/rspress-plugin-katex), render math formulas with KaTeX. - -### Code Transformers - -- [rspress-plugin-mermaid](./packages/rspress-plugin-mermaid), render diagrams with Mermaid. -- [rspress-plugin-file-tree](./packages/rspress-plugin-file-tree), render file tree as a tree view. - -### Extension - -- [rspress-plugin-directives](./packages/rspress-plugin-directives), custom directives support. - -### Themes - -- [rspress-plugin-live2d](./packages/rspress-plugin-live2d), add live2d model to your site. -- [rspress-plugin-toc](./packages/rspress-plugin-toc), generate table of contents for your pages. -- [rspress-plugin-reading-time](./packages/rspress-plugin-reading-time), calculate and display reading time for your pages. - -### Site - -- [rspress-plugin-google-analytics](./packages/rspress-plugin-google-analytics), integrate Google Analytics in your site. -- [rspress-plugin-vercel-analytics](./packages/rspress-plugin-vercel-analytics), integrate Vercel Analytics in your site. -- [ ] rspress-plugin-sitemap -- [ ] rspress-plugin-pwa - -### Deploy - -- [rspress-plugin-gh-pages](./packages/rspress-plugin-gh-pages), deploy your site to GitHub Pages without pushing. +A collection of plugins to extend the capabilities of [rspress](https://rspress.dev/), [vitepress](https://vitepress.dev/), and other static site generators.