chore: add docs

Author: Onlylonger

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: pnpm docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -2,3 +2,5 @@ node_modules
 dist
 *.log
 .DS_Store
+
+docs/.vitepress/cache

docs/.vitepress/config.ts

@@ -0,0 +1,33 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'Utils for Developers',
+  description: 'Make DX pleasure',
+  base: '/utils',
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      // { text: 'Home', link: '/' },
+      // { text: 'Examples', link: '/markdown-examples' },
+    ],
+
+    sidebar: [
+      {
+        // text: 'Browser',
+        items: [
+          { text: 'Getting Started', link: '/' },
+          { text: 'Configuration', link: '/configuration' },
+          { text: 'JS', link: '/js' },
+          { text: 'Browser', link: '/browser' },
+          { text: 'React', link: '/react' },
+          // { text: 'Runtime API Examples', link: '/api-examples' },
+        ],
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+    ],
+  },
+})

docs/api-examples.md

@@ -0,0 +1,49 @@
+---
+outline: deep
+---
+
+# Runtime API Examples
+
+This page demonstrates usage of some of the runtime APIs provided by VitePress.
+
+The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
+
+```md
+<script setup>
+import { useData } from 'vitepress'
+
+const { theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+```
+
+<script setup>
+import { useData } from 'vitepress'
+
+const { site, theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+
+## More
+
+Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

docs/browser.md

@@ -0,0 +1,36 @@
+# Browser
+
+## isBrowser
+
+用于判断当前环境是否支持浏览器运行环境
+
+### 使用方式
+
+```js
+import { isBrowser } from '@shilong/utils'
+
+if (isBrowser()) {
+  console.log('Browser environment')
+  document.getElementById('root')
+}
+```
+
+## copyToClipboard
+
+用于动态使用 js 将内容拷贝到设备粘贴板中，方便用户拷贝内容（可以理解为 **选中 + Ctrl/Cmd + C**）
+
+### 使用方式
+
+```js
+import { copyToClipboard } from '@shilong/utils'
+
+const ele = document.getElementById('root')
+ele.addEventListener('click', async () => {
+  const url = ele.getAttribute('data-url')
+  if (!url) return
+  const res = await copyToClipboard(url)
+  res && console.log(`链接内容 ${url} 已复制到粘贴板`)
+})
+```
+
+WIP...

docs/configuration.md

@@ -0,0 +1,39 @@
+# Configuration
+
+## HTTP STATUS
+
+参考 [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status) 进行一些常用的 **http status** 状态码以及描述信息的抽离
+
+### 使用
+
+```js
+import { httpStatus, type HttpStatusCode } from '@shilong/utils'
+
+console.log(httpStatus[500].msg) // -> Internal Server Error
+
+/**
+ * {
+    msg: 'Internal Server Error',
+  }
+*/
+console.log(httpStatus[500])
+```
+
+一般用在封装 **api** 的场景中，例如
+
+```js
+export const request = (input, init) => {
+  return fetch(input, init).then((res) => {
+    if (res.status >= 200 && res.status < 300) {
+      return res
+    } else {
+      throw new Error(
+        // 此处使用
+        res.statusText ? res.statusText : httpStatus[res.status].msg
+      )
+    }
+  })
+}
+```
+
+WIP...

docs/index.md

@@ -0,0 +1,23 @@
+# Getting Started
+
+## 安装
+
+目前只支持 ES 模块
+
+```sh
+npm install @shilong/utils --save
+# pnpm add @shilong/utils -S
+```
+
+### 使用
+
+```js
+import { isBrowser } from '@shilong/utils'
+
+if (isBrowser()) {
+  console.log('Browser environment')
+  document.getElementById('root')
+}
+```
+
+WIP...