feat: docs (#80)

.gitignore

@@ -93,3 +93,4 @@ packages/browser-extension/overlay/**/*
 packages/browser-extension/client/**/*
 packages/electron/client/**/*
 packages/vite/src/overlay/**/*
+docs/.vitepress/cache/

docs/.vitepress/components/Home.vue

@@ -0,0 +1,7 @@
+<template>
+  <div class="home" mt-4 flex flex-col items-center>
+    <HomeSponsors />
+
+    <!-- <HomeContributors /> -->
+  </div>
+</template>

docs/.vitepress/components/HomeContributors.vue

@@ -0,0 +1,12 @@
+<template>
+  <div class="vp-doc">
+    <h2 pb-2 pt-5 font-normal op50>
+      Contributors
+    </h2>
+  </div>
+  <p id="contributors" class="mt-5 text-center">
+    <a href="https://github.com/vuejs/devtools-next/graphs/contributors">
+      <img src="https://contrib.rocks/image?repo=vuejs/devtools-next">
+    </a>
+  </p>
+</template>

docs/.vitepress/components/HomeSponsors.vue

@@ -0,0 +1,12 @@
+<template>
+  <div class="vp-doc">
+    <h2 pb-2 pt-5 font-normal op50>
+      Sponsored by
+    </h2>
+  </div>
+  <p id="sponsor" class="mt-5 text-center">
+    <a href="https://github.com/sponsors/webfansplz">
+      <img src="https://cdn.jsdelivr.net/gh/webfansplz/sponsors/sponsors.wide.svg" class="m-auto">
+    </a>
+  </p>
+</template>

docs/.vitepress/config.ts

@@ -0,0 +1,92 @@
+import type { DefaultTheme } from 'vitepress'
+import { defineConfig } from 'vitepress'
+import { version } from '../../package.json'
+import vite from './vite.config'
+
+const GUIDES: DefaultTheme.NavItemWithLink[] = [
+  { text: 'Getting Started', link: '/guide/getting-started' },
+  { text: 'Features', link: '/guide/features' },
+  { text: 'Vite Plugin', link: '/guide/vite-plugin' },
+  { text: 'Browser Extension', link: '/guide/browser-extension' },
+  { text: 'Standalone App', link: '/guide/standalone' },
+]
+
+const VERSIONS: DefaultTheme.NavItemWithLink[] = [
+  { text: `v${version} (current)`, link: '/' },
+]
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'Vue DevTools',
+  description: 'Unleash Vue Developer Experience',
+  markdown: {
+    theme: {
+      light: 'vitesse-light',
+      dark: 'vitesse-dark',
+    },
+  },
+
+  cleanUrls: true,
+  vite,
+  themeConfig: {
+    siteTitle: false,
+    logo: { src: '/logo-mini.svg', width: 60, height: 60 },
+    nav: [
+      {
+        text: 'Guide',
+        items: [
+          {
+            items: GUIDES,
+          },
+        ],
+      },
+      {
+        text: `v${version}`,
+        items: VERSIONS,
+      },
+    ],
+
+    sidebar: Object.assign(
+      {},
+      {
+        '/': [
+          {
+            text: 'Guide',
+            items: GUIDES,
+          },
+        ],
+      },
+    ),
+
+    editLink: {
+      pattern: 'https://github.com/vuejs/vue-devtools-next/edit/main/docs/:path',
+      text: 'Suggest changes to this page',
+    },
+    search: {
+      provider: 'local',
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/devtools-next' },
+    ],
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2023-PRESENT Arlo(webfansplz).',
+    },
+  },
+
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo-mini.svg' }],
+    ['meta', { name: 'theme-color', content: '#ffffff' }],
+    ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
+    ['meta', { name: 'author', content: 'Arlo(webfansplz)' }],
+    ['meta', { name: 'og:site_name', content: 'Vue DevTools' }],
+    ['meta', { property: 'og:title', content: 'Vue DevTools' }],
+    ['meta', { property: 'og:image', content: '' }],
+    ['meta', { property: 'og:description', content: 'Unleash Vue Developer Experience' }],
+    ['meta', { name: 'og:type', content: 'website' }],
+    ['meta', { name: 'og:locale', content: 'en' }],
+    ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1.0, viewport-fit=cover' }],
+  ],
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,15 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import Theme from 'vitepress/theme'
+import 'uno.css'
+import './style.css'
+
+export default {
+  extends: Theme,
+  Layout: () => {
+    return h(Theme.Layout, null, {})
+  },
+  enhanceApp({ app }: any) {
+    //
+  },
+}

docs/.vitepress/theme/style.css

@@ -0,0 +1,141 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ *
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: #4acf93;
+  --vp-c-brand-2: #42d392;
+  --vp-c-brand-3: #46e392;
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #42d392 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #4acf93 50%,
+    #c3edda 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+  .VPHero .text {
+    max-width: 600px;
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}

docs/.vitepress/uno.config.ts

@@ -0,0 +1,28 @@
+import {
+  defineConfig,
+  presetAttributify,
+  presetIcons,
+  presetUno,
+} from 'unocss'
+
+export default defineConfig({
+  shortcuts: {
+    'border-base': 'border-color-$vp-c-divider',
+    'text-brand': 'color-$vp-c-brand-1',
+    'text-brand-yellow': 'color-$vp-c-yellow-1',
+    'text-brand-red': 'color-$vp-c-red-1',
+  },
+  blocklist: [
+    'container',
+  ],
+  presets: [
+    presetUno(),
+    presetAttributify(),
+    presetIcons(),
+  ],
+  safelist: [
+    'font-mono',
+    'mb0!',
+    'no-underline!',
+  ],
+})

docs/.vitepress/vite.config.ts

@@ -0,0 +1,20 @@
+import { fileURLToPath } from 'node:url'
+import { defineConfig } from 'vite'
+import UnoCSS from 'unocss/vite'
+import Components from 'unplugin-vue-components/vite'
+
+export default defineConfig({
+  plugins: [
+    Components({
+      dirs: [
+        fileURLToPath(new URL('./components', import.meta.url)),
+      ],
+      dts: fileURLToPath(new URL('../components.d.ts', import.meta.url)),
+      include: [/\.vue$/, /\.vue\?vue/, /\.md$/],
+      extensions: ['vue', 'md'],
+    }),
+    UnoCSS(
+      fileURLToPath(new URL('./uno.config.ts', import.meta.url)),
+    ),
+  ],
+})

docs/guide/browser-extension.md

@@ -0,0 +1,7 @@
+# Browser Extension
+
+:::tip ⚠️
+
+This feature is still under development and coming soon.
+
+:::