📝 Update readme

nonebot · Aug 30, 2023 · 6f1a5ff · 6f1a5ff
1 parent 9aa5c7e
commit 6f1a5ff
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,13 @@
 # Docusaurus Theme Nonepress
 
+[![GitHub](https://img.shields.io/github/license/nonebot/docusaurus-theme-nonepress)](https://github.com/nonebot/docusaurus-theme-nonepress/blob/master/LICENSE)
+[![npm](https://img.shields.io/npm/v/@nullbot/docusaurus-theme-nonepress)](https://www.npmjs.com/package/@nullbot/docusaurus-theme-nonepress)
+
 ## Installation
 
 ```bash
 npx create-docusaurus@latest website classic
-npm i --save docusaurus-preset-nonepress
+yarn add @nullbot/docusaurus-preset-nonepress
 ```
 
 Modify your `docusaurus.config.js`:
@@ -14,8 +17,8 @@ module.exports = {
   ...
 + presets: [
 +   [
-+     "docusaurus-preset-nonepress",
-+     /** @type {import("docusaurus-preset-nonepress").Options} */
++     "@nullbot/docusaurus-preset-nonepress",
++     /** @type {import('@nullbot/docusaurus-preset-nonepress').Options} */
 +     ({docs: docConfig, pages: pageConfig}),
 +   ]
 + ]

diff --git a/packages/plugin-docsmenu/README.md b/packages/plugin-docsmenu/README.md
@@ -0,0 +1,3 @@
+# Docusaurus Plugin DocsMenu
+
+DocsMenu data provider for Docusaurus Theme Nonepress.
diff --git a/packages/plugin-getsidebar/README.md b/packages/plugin-getsidebar/README.md
@@ -0,0 +1,3 @@
+# Docusaurus Plugin GetSidebar
+
+Sidebar data provider for Docusaurus Theme Nonepress.
diff --git a/packages/plugin-getsidebar/package.json b/packages/plugin-getsidebar/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@nullbot/docusaurus-plugin-getsidebar",
   "version": "2.1.0",
-  "description": "DocMenu plugin for Nonepress theme",
+  "description": "GetSidebar plugin for Nonepress theme",
   "main": "lib/index.js",
   "exports": {
     "./lib/*": "./lib/*",

diff --git a/packages/theme-nonepress/README.md b/packages/theme-nonepress/README.md
@@ -1,31 +1,27 @@
 # Docusaurus Theme Nonepress
 
-The nonepress theme for Docusaurus.
+[![GitHub](https://img.shields.io/github/license/nonebot/docusaurus-theme-nonepress)](https://github.com/nonebot/docusaurus-theme-nonepress/blob/master/LICENSE)
+[![npm](https://img.shields.io/npm/v/@nullbot/docusaurus-theme-nonepress)](https://www.npmjs.com/package/@nullbot/docusaurus-theme-nonepress)
 
 ## Installation
 
-### Use `docusaurus-preset-nonepress`
-
-See [docusaurus-preset-nonepress](https://www.npmjs.com/package/docusaurus-preset-nonepress)
-
-### Manually Install
-
-Add `docusaurus-theme-nonepress` to your package:
-
 ```bash
-npm i --save docusaurus-theme-nonepress@latest
+npx create-docusaurus@latest website classic
+yarn add @nullbot/docusaurus-preset-nonepress
 ```
 
 Modify your `docusaurus.config.js`:
 
 ```diff
 module.exports = {
   ...
-+ themes: ["docusaurus-theme-nonepress"],
-+ plugins: [
-+   "@docusaurus/plugin-content-docs",
-+   "@docusaurus/plugin-content-pages",
-+ ],
++ presets: [
++   [
++     "@nullbot/docusaurus-preset-nonepress",
++     /** @type {import('@nullbot/docusaurus-preset-nonepress').Options} */
++     ({docs: docConfig, pages: pageConfig}),
++   ]
++ ]
   ...
 }
 ```