chore: vitepress (#1264)

.github/workflows/deploy.yml

@@ -0,0 +1,33 @@
+name: Deploy
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: npm
+      - run: npm ci
+      - name: Build
+        run: npm run docs:build
+      - uses: actions/configure-pages@v2
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/.vitepress/dist
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -3,3 +3,5 @@ node_modules
 husky-*.tgz
 tsconfig.tsbuildinfo
 *.log
+docs/.vitepress/cache
+docs/.vitepress/dist

docs/.vitepress/config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: '🐶 husky',
+  description: 'Git hooks made easy',
+  base: '/husky/',
+  themeConfig: {
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/typicode/husky' },
+    ],
+    carbonAds: {
+      code: 'CWYDP53L',
+      placement: 'typicodegithubio',
+    },
+  },
+})