[feat] initialize

.vitepress/config.mts

@@ -0,0 +1,35 @@
+import { defineConfig } from 'vitepress'
+import generateSidebarByPath from './sidebar.mts'
+import type { SidebarAutoItem } from './sidebar.mts'
+
+const sidebarAuto: SidebarAutoItem[] = [
+  {
+    text: 'Kinesin',
+    path: '/kinesin',
+  }
+]
+
+const sidebarByPath = generateSidebarByPath(sidebarAuto)
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'KeDocs',
+  description: '代码跃海 世界同潮',
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: '知识库', link: 'https://kegongteng.cn' },
+      { text: '联系', link: 'mailto:i@kegongteng.cn' },
+    ],
+
+    logo: {
+      dark: "/avatar-dark.png",
+      light: "/avatar.png",
+    },
+    sidebar: sidebarByPath,
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/gtxykn0504' }
+    ]
+  }
+})

.vitepress/sidebar.mts

@@ -0,0 +1,140 @@
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const docsRoot = path.resolve(__dirname, '..')
+
+export type SidebarAutoItem = {
+  text: string
+  path: string
+}
+
+export type SidebarItem = {
+  text: string
+  link: string
+}
+
+export type SidebarGroup = {
+  text: string
+  items: SidebarItem[]
+}
+
+function normalizeLink(link: string) {
+  if (!link.startsWith('/')) return `/${link}`
+  return link
+}
+
+type ResolvedPath = {
+  scopePath: string
+  scopeKey: string
+  absDir: string
+  isRoot: boolean
+}
+
+function resolvePathConfig(rawPath: string): ResolvedPath {
+  const normalized = rawPath.trim().replace(/\\/g, '/')
+
+  if (!normalized) {
+    throw new Error('path cannot be empty.')
+  }
+
+  if (!normalized.startsWith('/')) {
+    throw new Error(`path must start with '/'. Received: ${rawPath}`)
+  }
+
+  const scopePath = normalized === '/'
+    ? '/'
+    : `/${normalized.replace(/^\/+/, '').replace(/\/+$/, '')}`
+  const scopeKey = scopePath === '/' ? '/' : `${scopePath}/`
+  const relative = scopePath === '/' ? '' : scopePath.slice(1)
+
+  return {
+    scopePath,
+    scopeKey,
+    absDir: path.resolve(docsRoot, relative),
+    isRoot: scopePath === '/'
+  }
+}
+
+function toLink(relativePath: string) {
+  return normalizeLink(relativePath ? `/${relativePath}` : '/')
+}
+
+function readFrontmatterAndTitle(filePath: string) {
+  const raw = fs.readFileSync(filePath, 'utf8')
+  const fmMatch = raw.match(/^---\s*([\s\S]*?)\s*---/)
+  let order = Number.POSITIVE_INFINITY
+
+  if (fmMatch) {
+    const fm = fmMatch[1]
+    const orderMatch = fm.match(/^\s*order\s*:\s*([-+]?\d+(?:\.\d+)?)/m)
+    if (orderMatch) order = Number(orderMatch[1])
+  }
+
+  const h1 = raw.match(/^#\s+(.+)$/m)
+  const title = h1 ? h1[1].trim() : path.basename(filePath, '.md')
+
+  return { order, title }
+}
+
+function generateSidebarGroup(entry: SidebarAutoItem): SidebarGroup {
+  const { absDir, isRoot } = resolvePathConfig(entry.path)
+
+  if (!fs.existsSync(absDir)) {
+    return { text: entry.text, items: [] }
+  }
+
+  const relativeDir = path.relative(docsRoot, absDir).split(path.sep).join('/')
+  const files = fs.readdirSync(absDir).filter((name) => {
+    if (!name.endsWith('.md')) return false
+    // When scanning docs root '/', do not include root index.md in sidebar.
+    if (isRoot && name.toLowerCase() === 'index.md') return false
+    return true
+  })
+
+  const items = files
+    .map((name) => {
+      const full = path.join(absDir, name)
+      const { order, title } = readFrontmatterAndTitle(full)
+      const baseName = path.basename(name, '.md')
+      const rel = relativeDir ? `${relativeDir}/${baseName}` : baseName
+
+      // index.md -> 目录根路径
+      const link = baseName === 'index' ? toLink(relativeDir) : toLink(rel)
+
+      return {
+        order,
+        text: title,
+        link
+      }
+    })
+    .sort((a, b) => {
+      if (a.order === b.order) return a.text.localeCompare(b.text)
+      return a.order - b.order
+    })
+
+  return {
+    text: entry.text,
+    items: items.map(({ text, link }): SidebarItem => ({ text, link }))
+  }
+}
+
+export function generateSidebarByPath(sidebarAuto: SidebarAutoItem[]) {
+  const sidebarConfig: Record<string, SidebarGroup[]> = {}
+
+  for (const entry of sidebarAuto) {
+    const { scopeKey } = resolvePathConfig(entry.path)
+    const group = generateSidebarGroup(entry)
+
+    if (!sidebarConfig[scopeKey]) {
+      sidebarConfig[scopeKey] = []
+    }
+
+    sidebarConfig[scopeKey].push(group)
+  }
+
+  return sidebarConfig
+}
+
+export default generateSidebarByPath

.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * 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 attached 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: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --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,
+    #bd34fe 30%,
+    #41d1ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #bd34fe 50%,
+    #47caff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@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;
+}
+