docs: trans dumi to vitepress for documents

Author: vortesnail

.github/workflows/gh-pages.yml

@@ -1,26 +1,32 @@
-name: Deploy GitHub Pages
+name: Deploy QierPlayer Docs to GitHub Pages
 
 on:
   push:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
-  build-and-deploy:
-    runs-on: macos-latest
+  # 构建工作
+  build:
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
-
+          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn # 或 pnpm / npm
       - name: Build
         working-directory: ./website
         run: yarn && yarn build
-
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@4.1.4
         with:
           token: ${{ secrets.GITHUB_TOKEN  }}
           branch: gh-pages
-          folder: website/dist
+          folder: website/docs/.vitepress/dist

.prettierignore

@@ -1,3 +1,4 @@
 /**/node_modules
 /**/build
 /**/dist
+/**/website

.vscode/settings.json

@@ -14,8 +14,8 @@
 
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true,
-    "source.fixAll.stylelint": true
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
   },
   "[javascript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"

README-zh-Cn.md

@@ -49,12 +49,6 @@ npm install --save qier-player
 yarn add qier-player
 ```
 
-当然你也可以使用 CDN 服务：
-
-```html
-<script src="https://unpkg.com/qier-player@latest/dist/umd/index.min.js"></script>
-```
-
 ### 使用
 
 ```js
@@ -65,14 +59,3 @@ const player = new Player({
 });
 player.mount('#app');
 ```
-
-## 生态
-
-| Name | version | gzip size |
-| --- | --- | --- |
-| [qier-player-for-react]() | [![npm](https://img.shields.io/npm/v/@qier-player/react?logo=npm&style=flat-square)](https://www.npmjs.com/package/@qier-player/react) | [![gzip size](https://img.shields.io/bundlephobia/minzip/@qier-player/react?label=gzip%20size&style=flat-square)](https://unpkg.com/@qier-player/react@2.0.1/dist/umd/index.min.js) |
-
-## Future features
-
-- `@qier-player/vue` for Vue developer.
-- `@qier-player/danmaku` plungin.

README.md

@@ -49,12 +49,6 @@ npm install --save qier-player
 yarn add qier-player
 ```
 
-Of course you can also use CDN service:
-
-```html
-<script src="https://unpkg.com/qier-player@latest/dist/umd/index.min.js"></script>
-```
-
 ### Use
 
 ```js
@@ -65,14 +59,3 @@ const player = new Player({
 });
 player.mount('#app');
 ```
-
-## Ecosystem
-
-| Name | version | gzip size |
-| --- | --- | --- |
-| [qier-player-for-react]() | [![npm](https://img.shields.io/npm/v/@qier-player/react?logo=npm&style=flat-square)](https://www.npmjs.com/package/@qier-player/react) | [![gzip size](https://img.shields.io/bundlephobia/minzip/@qier-player/react?label=gzip%20size&style=flat-square)](https://unpkg.com/@qier-player/react@2.0.1/dist/umd/index.min.js) |
-
-## Future features
-
-- `@qier-player/vue` for Vue developer.
-- `@qier-player/danmaku` plungin.

fixtures/qier-player-danmaku/index.js

@@ -145,7 +145,8 @@ window.onload = function () {
   const genDanmu = (time, danmu) => {
     if (!danmu) return;
     setTimeout(() => {
-      danmaku.add(danmu, 'fixed-top');
+      // danmaku.add(danmu, 'fixed-top');
+      danmaku.add(danmu, 'rolling');
     }, time);
   };
 

packages/qier-player-danmaku/package.json

@@ -4,7 +4,7 @@
   "description": "Powerful danmaku, support many features.",
   "main": "dist/es/index.js",
   "module": "dist/es/index.js",
-  "types": "dist/es/index.d.ts",
+  "typings": "dist/es/index.d.ts",
   "author": "vortesnail <1091331061@qq.com>",
   "files": [
     "dist"

packages/qier-player-danmaku/src/index.ts

@@ -1,3 +1,4 @@
 import './style/index.scss';
 
 export { Danmaku as default } from './main/danmaku';
+export * from './main/danmaku';

packages/qier-player-danmaku/src/main/types.ts

@@ -8,7 +8,7 @@ export interface DanmakuOptions {
   duration: number;
   zoom: number;
 
-  eventProxyElement?: HTMLHtmlElement; // 弹幕交互的事件代理 dom 元素
+  eventProxyElement?: HTMLElement; // 弹幕交互的事件代理 dom 元素
 }
 
 export type DanmakuOptionsInit = Partial<DanmakuOptions>;

packages/qier-player/package.json

@@ -4,7 +4,7 @@
   "description": "Easy to use and powerful html5 player.",
   "main": "dist/es/index.js",
   "module": "dist/es/index.js",
-  "types": "dist/es/index.d.ts",
+  "typings": "dist/es/index.d.ts",
   "author": "vortesnail <1091331061@qq.com>",
   "files": [
     "dist"

packages/qier-player/src/main/modules/controller/eles/settings.ts

@@ -56,6 +56,7 @@ class Settings extends DomNode implements IControllerEle {
     this.items = player.settingItems;
     this.el.appendChild(Icon.settings());
 
+    // 占位填充弹框和 icon 之间的空白，防止光标移开 icon 弹框就消失
     this.stuffing = this.el.appendChild(createEle('div.controller_settings_stuffing'));
 
     this.popover = new Popover(this.el, { willChange: 'width, height' });

website/.editorconfig

@@ -1,22 +1,14 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
 # dependencies
 /node_modules
 /npm-debug.log*
 /yarn-error.log
-/package-lock.json
 
 # production
 /dist
 
 # misc
 .DS_Store
 
-# umi
-.umi
-.umi-production
-.env.local
-
-# ide
-/.vscode
-/.idea
+# custom ignore
+docs/.vitepress/cache
+docs/.vitepress/dist