11# Danmaku
22
3- [ ![ GitHub Action] ( https://github.com/weizhenye/Danmaku/workflows/CI/badge.svg )] ( https://github.com/weizhenye/Danmaku/actions )
4- [ ![ Coverage] ( https://badgen.net/codecov/c/github/weizhenye/Danmaku?icon=codecov )] ( https://codecov.io/gh/weizhenye/Danmaku )
5- [ ![ NPM version] ( https://badgen.net/npm/v/danmaku?icon=npm )] ( https://www.npmjs.com/package/danmaku )
6- [ ![ License] ( https://badgen.net/npm/license/danmaku?icon=https://api.iconify.design/octicon:law.svg?color=white )] ( https://github.com/weizhenye/Danmaku/blob/master/LICENSE )
7- [ ![ File size] ( https://badgen.net/bundlephobia/minzip/danmaku?icon=https://api.iconify.design/ant-design:file-zip-outline.svg?color=white )] ( https://bundlephobia.com/result?p=danmaku )
8- [ ![ jsDelivr] ( https://badgen.net/jsdelivr/hits/npm/danmaku?icon=https://api.iconify.design/simple-icons:jsdelivr.svg?color=white )] ( https://www.jsdelivr.com/package/npm/danmaku )
3+ [ ![ GitHub Action] ( https://img.shields.io/github/actions/workflow/status/weizhenye/Danmaku/ci.yml?logo=github )] ( https://github.com/weizhenye/Danmaku/actions )
4+ [ ![ Codecov] ( https://img.shields.io/codecov/c/gh/weizhenye/Danmaku?logo=codecov )] ( https://codecov.io/gh/weizhenye/Danmaku )
5+ [ ![ License] ( https://img.shields.io/npm/l/danmaku )] ( https://github.com/weizhenye/danmaku/blob/master/LICENSE )
6+ [ ![ File size] ( https://img.shields.io/bundlephobia/minzip/danmaku )] ( https://bundlephobia.com/result?p=danmaku )
97
10- [ ![ Browser compatibility] ( https://saucelabs.com/browser-matrix/danmaku.svg )] ( https://saucelabs.com/u/danmaku )
8+ <span >・</span >
9+ <a href =" https://danmaku.js.org/ " >Online Demo</a >
10+ <span >・</span >
11+ <a href =" https://github.com/weizhenye/Danmaku/wiki/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3 " >中文文档</a >
12+ <span >・</span >
1113
1214Danmaku is a JavaScript library to display flying comments on HTML media elements (video and audio). It can also display comments to your container in real time without timeline.
1315
14- [ Demo] ( https://danmaku.js.org/ )
15-
16- [ 中文文档] ( https://github.com/weizhenye/Danmaku/wiki/%E4%B8%AD%E6%96%87%E6%96%87%E6%A1%A3 )
17-
1816## Installation
1917
20- You can install it with npm:
18+ [ ![ NPM Version] ( https://img.shields.io/npm/v/danmaku?logo=npm )] ( https://www.npmjs.com/package/danmaku )
19+ [ ![ jsDelivr] ( https://img.shields.io/jsdelivr/npm/hm/danmaku?logo=jsdelivr )] ( https://www.jsdelivr.com/package/npm/danmaku )
20+ [ ![ ] ( https://img.shields.io/badge/unpkg-555?logo=unpkg )] ( https://unpkg.com/danmaku/ )
2121
2222``` bash
2323npm install danmaku
@@ -32,15 +32,6 @@ import Danmaku from 'danmaku/dist/esm/danmaku.dom.js';
3232import Danmaku from ' danmaku/dist/esm/danmaku.canvas.js' ;
3333```
3434
35- Or use CDN ([ jsDelivr] ( https://www.jsdelivr.com/package/npm/danmaku ) , [ unpkg] ( https://unpkg.com/danmaku/ ) ):
36-
37- | | Full | DOM engine only | Canvas engine only |
38- | - | - | - | - |
39- | UMD | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.js?label=danmaku.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.dom.js?label=danmaku.dom.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.dom.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.canvas.js?label=danmaku.canvas.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.canvas.js ) |
40- | UMD minified | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.min.js?label=danmaku.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.min.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.dom.min.js?label=danmaku.dom.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.dom.min.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/danmaku.canvas.min.js?label=danmaku.canvas.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/danmaku.canvas.min.js ) |
41- | ESM | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.js?label=esm/danmaku.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.dom.js?label=esm/danmaku.dom.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.dom.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.canvas.js?label=esm/danmaku.canvas.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.canvas.js ) |
42- | ESM minified | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.min.js?label=esm/danmaku.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.min.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.dom.min.js?label=esm/danmaku.dom.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.dom.min.js ) | [ ![ ] ( https://badgen.net/badgesize/gzip/weizhenye/danmaku/master/dist/esm/danmaku.canvas.min.js?label=esm/danmaku.canvas.min.js )] ( https://cdn.jsdelivr.net/npm/danmaku/dist/esm/danmaku.canvas.min.js ) |
43-
4435## Usage
4536
4637### Media mode
@@ -139,7 +130,6 @@ var danmaku = new Danmaku({
139130 comments: [],
140131
141132 // You can use DOM engine or canvas engine to render comments.
142- // Canvas engine may more efficient than DOM however it costs more memory.
143133 // 'DOM' by default in full version.
144134 engine: ' canvas' ,
145135
0 commit comments