docs: move to vitepress (#688)

* docs: init vitepress

* chore: update package lock

* ci: drop v12 and add v18

* docs: remove old urls

* docs: add logo to readme

Author: fratzinger

.github/workflows/nodejs.yml

@@ -5,11 +5,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install

README.md

@@ -1,5 +1,9 @@
 ## feathers-hooks-common
 
+<p align="center">
+  <img src="https://hooks-common.feathersjs.com/feathers-hooks-common-logo.png" width="200">
+</p>
+
 [![npm](https://img.shields.io/npm/v/feathers-hooks-common)](https://www.npmjs.com/package/feathers-hooks-common)
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/feathersjs-ecosystem/feathers-hooks-common/CI/master)](https://github.com/feathersjs-ecosystem/feathers-hooks-common/actions/workflows/nodejs.yml?query=branch%3Amaster)
 [![libraries.io](https://img.shields.io/librariesio/release/npm/feathers-hooks-common)](https://libraries.io/npm/feathers-hooks-common)

docs/.vitepress/config.ts

@@ -0,0 +1,39 @@
+import { defineConfig } from "vitepress";
+
+export default defineConfig({
+  title: "feathers-hooks-common",
+  lastUpdated: true,
+  description: "",
+  head: [["link", { rel: "icon", href: "/feathers-hooks-common-logo.png" }]],
+  themeConfig: {
+    siteTitle: "feathers-hooks-common",
+    editLink: {
+      pattern:
+        "https://github.com/feathersjs-ecosystem/feathers-hooks-common/edit/master/docs/:path",
+    },
+    lastUpdatedText: "Last Updated",
+    socialLinks: [
+      {
+        icon: "github",
+        link: "https://github.com/feathersjs-ecosystem/feathers-hooks-common",
+      },
+    ],
+    logo: "/feathers-hooks-common-logo.png",
+    sidebar: [
+      {
+        text: "Guide",
+        items: [
+          { text: "Overview", link: "/overview" },
+          { text: "Hooks", link: "/hooks" },
+          { text: "Utilities", link: "/utilities" },
+          { text: "Migrating", link: "/migrating" },
+          { text: "Guides", link: "/guides" },
+        ],
+      },
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright © 2016-present Feathers contributors",
+    },
+  },
+});

docs/.vitepress/style/main.css

@@ -0,0 +1,62 @@
+/**
+ * Colors
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-accent: #dab40b;
+  --vp-c-brand: #ae0bb1;
+  --vp-c-brand-light: #bc0cbf;
+  --vp-c-brand-lighter: #c80dcb;
+  --vp-c-brand-dark: #9b089e;
+  --vp-c-brand-darker: #8b048e;
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: var(--vp-c-brand-light);
+  --vp-button-brand-text: var(--vp-c-text-dark-1);
+  --vp-button-brand-bg: var(--vp-c-brand);
+  --vp-button-brand-hover-border: var(--vp-c-brand-light);
+  --vp-button-brand-hover-text: var(--vp-c-text-dark-1);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-light);
+  --vp-button-brand-active-border: var(--vp-c-brand-light);
+  --vp-button-brand-active-text: var(--vp-c-text-dark-1);
+  --vp-button-brand-active-bg: var(--vp-button-brand-bg);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #7a067c 20%,
+    #d313d6
+  );
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(72px);
+  }
+}
+
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand) !important;
+}

docs/.vitepress/theme/index.ts

@@ -0,0 +1,6 @@
+import Theme from 'vitepress/theme'
+import '../style/main.css'
+
+export default {
+  ...Theme,
+}