docs: update the documentation

tapioca24 · Mar 26, 2023 · a31042e · a31042e
1 parent fe87aad
commit a31042e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ If you think it's good, give me a star! :star:
   - [TypeScript](#typescript)
 - [Configuration](#configuration)
 - [Methods](#methods)
+- [Compatibility](#compatibility)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -172,6 +173,15 @@ player.on('play', () => {
 | show() | Show the logo image |
 | hide() | Hide the logo image |
 
+## Compatibility
+
+videojs-logo vs video.js
+
+| videojs-logo | video.js |
+| ------------ | -------- |
+| v3.x         | v8.x     |
+| v2.x         | v7.x     |
+
 ## License
 
 MIT. Copyright (c) tapioca24

diff --git a/docs/api/Logo.html b/docs/api/Logo.html
@@ -868,7 +868,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Logo.html
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jun 25 2021 22:22:49 GMT+0900 (日本標準時)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Mar 26 2023 13:22:53 GMT+0900 (日本標準時)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Logo.html
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jun 25 2021 22:22:49 GMT+0900 (日本標準時)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Mar 26 2023 13:22:52 GMT+0900 (日本標準時)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/api/plugin.js.html b/docs/api/plugin.js.html
@@ -27,7 +27,7 @@ <h1 class="page-title">Source: plugin.js</h1>
     <section>
         <article>
             <pre class="prettyprint source linenums"><code>import videojs from 'video.js';
-import {version as VERSION} from '../package.json';
+import { version as VERSION } from '../package.json';
 const Plugin = videojs.getPlugin('plugin');
 
 // Default options for the plugin.
@@ -70,7 +70,7 @@ <h1 class="page-title">Source: plugin.js</h1>
     super(player);
     this.tid = null;
     this.div = null;
-    this.options = videojs.mergeOptions(defaults, options);
+    this.options = videojs.obj.merge(defaults, options);
     this.player.ready(() => this._onPlayerReady());
   }
 
@@ -155,7 +155,7 @@ <h1 class="page-title">Source: plugin.js</h1>
       const a = document.createElement('a'); // eslint-disable-line no-undef
 
       a.href = this.options.url;
-      a.onclick = e => {
+      a.onclick = (e) => {
         e.preventDefault();
         window.open(this.options.url); // eslint-disable-line no-undef
       };
@@ -230,7 +230,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Logo.html
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Fri Jun 25 2021 22:22:49 GMT+0900 (日本標準時)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a> on Sun Mar 26 2023 13:22:52 GMT+0900 (日本標準時)
 </footer>
 
 <script> prettyPrint(); </script>