chore: add README.md and bump dependencies

README.md

@@ -0,0 +1,27 @@
+<br>
+
+<p align="center">
+<img src="./docs/src/public/logo.svg" style="width:100px;" alt="logo" />
+</p>
+
+<h1 align="center">remark-magic-link</h1>
+
+<p align="center">
+🔌 A remark plugin to turn `{text}` syntax into links, optionally with an icon
+</p>
+
+<p align="center">
+<a href="https://www.npmjs.com/package/remark-magic-link"><img src="https://img.shields.io/npm/v/remark-magic-link?color=ffc0cb" alt="NPM version"></a>
+</p>
+
+<br>
+
+<p align="center">
+<a href="https://remark-magic-link.aelita.me/">📚 Documentation</a>
+</p>
+
+<br>
+
+## License
+
+[MIT](https://github.com/xsjcTony/remark-magic-link/blob/main/LICENSE) License © 2024-present [Aelita (Tony Jiang)](https://aelita.me/)

docs/.vitepress/config.ts

@@ -24,12 +24,15 @@ export default defineConfig({
     optimizeDeps: {
       exclude: [
         '@nolebase/vitepress-plugin-enhanced-readabilities/client',
+        'vitepress',
+        '@nolebase/ui',
       ],
     },
     ssr: {
       noExternal: [
         '@nolebase/vitepress-plugin-enhanced-readabilities',
         '@nolebase/vitepress-plugin-highlight-targeted-heading',
+        '@nolebase/ui',
       ],
     },
     css: {
@@ -62,7 +65,6 @@ export default defineConfig({
       md.use(groupIconMdPlugin)
     },
     codeTransformers: [
-      // @ts-expect-error - `shiki` version mismatch, but it works
       transformerTwoslash(),
     ],
   },

docs/.vitepress/theme/Layout.vue

@@ -9,7 +9,7 @@ const { isDark } = useData()
 
 function enableTransitions(): boolean {
   return 'startViewTransition' in document
-    && window.matchMedia('(prefers-reduced-motion: no-preference)').matches
+    && globalThis.matchMedia('(prefers-reduced-motion: no-preference)').matches
 }
 
 provide('toggle-appearance', async () => {

docs/src/api/index.md

@@ -18,7 +18,7 @@ interface RemarkMagicLinkOptions {
 
 - Type: `Record<string, string | { link: string; icon?: string | false }>`
 
-An object of key-value pairs where the keys are the texts to be matched and the values are the links and icons to be used.
+An object of key-value pairs where keys are the texts to be matched and values are the links and icons to be used.
 
 ::: warning
 This is required if you are using the default [handlers](/api/handler), otherwise nothing will be done.

docs/src/guide/index.md

@@ -171,7 +171,7 @@ If you want to customize it yourself, the plugin generates a well-structured HTM
 
 ## Options
 
-The only required option is [`linksMap`](/api/#linksMap) if you are using the default [handlers](/api/handler), which is an object where the keys are the texts to be matched and the values are the links and icons to be used.
+The only required option is [`linksMap`](/api/#linksMap) if you are using the default [handlers](/api/handler), which is an object where keys are the texts to be matched and values are the links and icons to be used.
 
 Refer to [API Reference](/api/) for advanced usages.
 

eslintConfig.ts

@@ -3,6 +3,7 @@ import { defineConfig } from '@aelita-dev/eslint-config'
 
 export default defineConfig(
   {
+    ignores: ['README.md'],
     typescript: {
       projectType: 'lib',
     },

package.json

@@ -2,7 +2,7 @@
   "name": "remark-magic-link",
   "version": "1.0.0",
   "description": "🔌 A remark plugin to turn {text} syntax into links, optionally with an icon",
-  "packageManager": "pnpm@9.11.0",
+  "packageManager": "pnpm@9.14.2",
   "type": "module",
   "author": "Aelita <https://github.com/xsjcTony>",
   "license": "MIT",
@@ -66,28 +66,27 @@
     "mdast-util-find-and-replace": "^3.0.1"
   },
   "devDependencies": {
-    "@aelita-dev/eslint-config": "3.2.8",
-    "@iconify/json": "^2.2.254",
-    "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.5.0",
-    "@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.5.0",
-    "@shikijs/vitepress-twoslash": "^1.21.0",
+    "@aelita-dev/eslint-config": "3.9.1",
+    "@iconify/json": "^2.2.276",
+    "@nolebase/vitepress-plugin-enhanced-readabilities": "^2.10.0",
+    "@nolebase/vitepress-plugin-highlight-targeted-heading": "^2.10.0",
+    "@shikijs/vitepress-twoslash": "^1.23.1",
     "@types/dom-view-transitions": "^1.0.5",
     "@types/markdown-it": "^14.1.2",
-    "@types/node": "^20.16.10",
-    "@unocss/eslint-plugin": "^0.63.1",
-    "@unocss/preset-rem-to-px": "^0.63.1",
-    "@vitest/coverage-v8": "^2.1.1",
-    "@vitest/eslint-plugin": "^1.1.4",
-    "@vue/language-server": "^2.1.6",
-    "bumpp": "^9.6.1",
+    "@types/node": "^20.17.8",
+    "@unocss/eslint-plugin": "^0.64.1",
+    "@unocss/preset-rem-to-px": "^0.64.1",
+    "@vitest/coverage-v8": "^2.1.5",
+    "@vitest/eslint-plugin": "^1.1.10",
+    "@vue/language-server": "^2.1.10",
+    "bumpp": "^9.8.1",
     "bundle-require": "^5.0.0",
-    "changelogithub": "^0.13.10",
-    "eslint": "^9.11.1",
-    "eslint-plugin-vue": "^9.28.0",
+    "changelogithub": "^0.13.11",
+    "eslint": "^9.15.0",
+    "eslint-plugin-vue": "^9.31.0",
     "eslint-plugin-vuejs-accessibility": "^2.4.1",
     "eslint-processor-vue-blocks": "^0.1.2",
     "lint-staged": "^15.2.10",
-    "postcss-prefix-selector": "^1.16.1",
     "rehype-format": "^5.0.1",
     "rehype-raw": "^7.0.0",
     "rehype-stringify": "^10.0.1",
@@ -96,20 +95,21 @@
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.1",
     "remark-stringify": "^11.0.0",
-    "sass": "^1.79.4",
+    "sass": "^1.81.0",
     "simple-git-hooks": "^2.11.1",
     "to-vfile": "^8.0.0",
-    "tsx": "^4.19.1",
-    "typescript": "^5.6.2",
-    "unbuild": "^3.0.0-rc.8",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "unbuild": "^3.0.0-rc.11",
     "unified": "^11.0.5",
-    "unocss": "^0.63.1",
+    "unocss": "^0.64.1",
     "vfile": "^6.0.3",
-    "vitepress": "^1.3.4",
-    "vitepress-plugin-group-icons": "^1.2.4",
-    "vitest": "^2.1.1",
-    "vue": "^3.5.10",
-    "vue-tsc": "^2.1.6",
-    "zx": "^8.1.8"
+    "vite-tsconfig-paths": "^5.1.3",
+    "vitepress": "^1.5.0",
+    "vitepress-plugin-group-icons": "^1.3.0",
+    "vitest": "^2.1.5",
+    "vue": "^3.5.13",
+    "vue-tsc": "^2.1.10",
+    "zx": "^8.2.2"
   }
 }