mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-30 03:51:25 -08:00
Refactor documentation for clarity and consistency
- Updated descriptions and terminology across various component documentation files for improved clarity. - Changed headings and section titles for better readability and consistency. - Enhanced the language and structure of the documentation to provide clearer guidance on usage and configuration. - Removed the `fix-docs.js` script as its functionality has been integrated into the translation process. - Improved the translation script to handle Markdown code block issues and added retry logic for API calls.
This commit is contained in:
1 parent
3adff76edf
commit
92f09a4290
15 files changed
+413
-372
No files matched your search
@@ -1,10 +1,10 @@
|
||||
# Static Properties
|
||||
|
||||
Here, `Static Properties` refer to the `top-level properties` mounted on the `constructor function`, which are very rarely used.
|
||||
Here, `static properties` refer to the `first-level properties` attached to the `constructor`, which are rarely used.
|
||||
|
||||
## `instances`
|
||||
|
||||
Returns an array of all player instances. This property can be useful when you need to manage multiple player instances simultaneously.
|
||||
Returns an array of all player instances. This property can be useful when you need to manage multiple players simultaneously.
|
||||
|
||||
<div className="run-code">▶ Run Code</div>
|
||||
|
||||
@@ -41,7 +41,7 @@ console.info(Artplayer.env);
|
||||
|
||||
## `build`
|
||||
|
||||
Returns the build time of the player.
|
||||
Returns the build timestamp of the player.
|
||||
|
||||
<div className="run-code">▶ Run Code</div>
|
||||
|
||||
@@ -87,7 +87,7 @@ console.info(Artplayer.scheme);
|
||||
|
||||
## `Emitter`
|
||||
|
||||
Returns the constructor function for the event emitter.
|
||||
Returns the constructor of the event emitter.
|
||||
|
||||
<div className="run-code">▶ Run Code</div>
|
||||
|
||||
@@ -107,7 +107,7 @@ console.info(Artplayer.validator);
|
||||
|
||||
## `kindOf`
|
||||
|
||||
Returns the utility function for type detection.
|
||||
Returns the type detection utility function.
|
||||
|
||||
<div className="run-code">▶ Run Code</div>
|
||||
|
||||
@@ -127,7 +127,7 @@ console.info(Artplayer.html);
|
||||
|
||||
## `option`
|
||||
|
||||
Returns the default options for the player.
|
||||
Returns the default options of the player.
|
||||
|
||||
<div className="run-code">▶ Run Code</div>
|
||||
|
||||
|
||||
Reference in new issue
Block a user