feat: init

Author: coderhyh

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Deploy Docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - 'packages/**/*.md'
+      - 'packages/.vitepress/**'
+      - 'packages/public/**'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: '8.x'
+
+      - name: Install and Build 🔧
+        uses: actions/[email protected]
+        with:
+          node-version: '16.x'
+          cache: pnpm
+      - run: pnpm i
+      - run: pnpm run docs:build
+
+      - name: Deploy to GitHub Pages 🚀
+        uses: JamesIves/[email protected]
+        with:
+          branch: pages
+          folder: packages/.vitepress/dist

.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish Package To Npmjs
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/[email protected]
+
+      - name: Configure Git
+        run: |
+          git config user.email "[email protected]"
+          git config user.name "coderhyh"
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: '8.x'
+
+      - uses: actions/[email protected]
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org/'
+          cache: pnpm
+
+      - name: ⏳ Install dependencies
+        run: pnpm i
+
+      - name: 👷  Build lib
+        run: pnpm run build
+
+      - name: 📦 Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+bin
+es
+lib
+cli
+dist-ssr
+.vitepress/cache
+*.local
+
+# Editor directories and files
+# .vscode/*
+# !.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.vitepress/config.ts

@@ -0,0 +1,53 @@
+import { resolve } from 'node:path'
+import { componentPreview, containerPreview } from '@vitepress-demo-preview/plugin'
+import Unocss from 'unocss/vite'
+import { defineConfig } from 'vitepress'
+
+import nav from './nav'
+import sidebar from './sidebar'
+
+export default defineConfig({
+  title: ' ',
+  description: 'coding-playground是一个vitepress的起始模板',
+  base: '/coding-playground',
+  lastUpdated: true,
+  head: [
+    [
+      'link',
+      {
+        rel: 'icon',
+        href: './vue-icon.svg',
+      },
+    ],
+    [
+      'meta',
+      {
+        name: 'viewport',
+        content: 'width=device-width,height=device-height, maximum-scale=1.0,minimum-scale=1.0',
+      },
+    ],
+  ],
+  themeConfig: {
+    logo: '/logo.svg',
+    nav,
+    sidebar,
+    socialLinks: [{ icon: 'github', link: 'https://github.com/coderhyh/coding-playground' }],
+    search: {
+      provider: 'local',
+    },
+  },
+  markdown: {
+    lineNumbers: true,
+    config(md) {
+      md.use(containerPreview)
+      md.use(componentPreview)
+    },
+  },
+  vite: {
+    resolve: { alias: { 'coding-playground': resolve(__dirname, '../packages') } },
+    plugins: [
+      // @ts-expect-error unocss返回类型错误
+      Unocss(),
+    ],
+  },
+})

.vitepress/nav.ts

@@ -0,0 +1,3 @@
+import type { DefaultTheme } from 'vitepress'
+
+export default <DefaultTheme.NavItem[]>[{ text: '首页', link: '/' }]

.vitepress/sidebar.ts

@@ -0,0 +1,16 @@
+import type { DefaultTheme } from 'vitepress'
+
+export default <DefaultTheme.Sidebar>[
+  {
+    text: '指引',
+    items: [{ text: '入手指南', link: '/' }],
+  },
+  {
+    text: '性能优化',
+    items: [{ text: 'useDefer', link: '/packages/performance/useDefer' }],
+  },
+  {
+    text: 'hooks',
+    items: [{ text: 'useSum', link: '/packages/hooks/useSum' }],
+  },
+]

.vitepress/theme/base.css

@@ -0,0 +1,24 @@
+::-webkit-scrollbar {
+  /* 滚动条整体样式 */
+  width: 5px; /* 高宽分别对应横竖滚动条的尺寸 */
+  height: 5px;
+}
+
+::-webkit-scrollbar-track {
+  /* 滚动条里面轨道 */
+  border-radius: 5px;
+}
+
+::-webkit-scrollbar-thumb {
+  /* 滚动条里面小方块 */
+  border-radius: 5px;
+  background: #dfdfdf;
+}
+
+::-webkit-scrollbar-thumb:hover {
+  background: #cfcfcf;
+}
+
+.vp-doc tr:nth-child(2n) {
+  background-color: inherit;
+}

.vitepress/theme/index.ts

@@ -0,0 +1,13 @@
+import { NaiveUIContainer } from '@vitepress-demo-preview/component'
+// https://vitepress.dev/guide/custom-theme
+import DefaultTheme from 'vitepress/theme'
+import '@vitepress-demo-preview/component/dist/style.css'
+import './base.css'
+import 'virtual:uno.css'
+
+export default {
+  ...DefaultTheme,
+  enhanceApp({ app, router, siteData }) {
+    app.component('demo-preview', NaiveUIContainer)
+  },
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": []
+}

.vscode/settings.json

@@ -0,0 +1,53 @@
+{
+  "stylelint.validate": ["css", "less", "vue", "html"],
+
+  // Disable the default formatter, use eslint instead
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never",
+    "source.fixAll.stylelint": "explicit"
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    { "rule": "style/*", "severity": "off", "fixable": true },
+    { "rule": "format/*", "severity": "off", "fixable": true },
+    { "rule": "*-indent", "severity": "off", "fixable": true },
+    { "rule": "*-spacing", "severity": "off", "fixable": true },
+    { "rule": "*-spaces", "severity": "off", "fixable": true },
+    { "rule": "*-order", "severity": "off", "fixable": true },
+    { "rule": "*-dangle", "severity": "off", "fixable": true },
+    { "rule": "*-newline", "severity": "off", "fixable": true },
+    { "rule": "*quotes", "severity": "off", "fixable": true },
+    { "rule": "*semi", "severity": "off", "fixable": true }
+  ],
+
+  // Enable eslint for all supported languages
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml",
+    "toml",
+    "xml",
+    "gql",
+    "graphql",
+    "astro",
+    "svelte",
+    "css",
+    "less",
+    "scss",
+    "pcss",
+    "postcss"
+  ]
+}