mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-31 04:31:20 -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
@@ -2,13 +2,13 @@
|
||||
|
||||
::: danger
|
||||
|
||||
Due to the increasing number of bundled multilingual resources, starting from version `5.1.0`, the core `artplayer.js` code will only include `Simplified Chinese` and `English`. Other languages are no longer bundled by default and must be imported manually as needed.
|
||||
Due to the increasing number of bundled multilingual resources, starting from version `5.1.0`, the core `artplayer.js` code will no longer bundle any languages other than `Simplified Chinese` and `English`. You will need to manually import any other languages you require.
|
||||
|
||||
:::
|
||||
|
||||
:::warning
|
||||
|
||||
When a language cannot be matched, English will be displayed by default. For i18n implementation reference, see: [artplayer/types/i18n.d.ts](https://github.com/zhw2590582/ArtPlayer/blob/master/packages/artplayer/types/i18n.d.ts)
|
||||
When a language cannot be matched, English will be displayed by default. For i18n syntax reference, see: [artplayer/types/i18n.d.ts](https://github.com/zhw2590582/ArtPlayer/blob/master/packages/artplayer/types/i18n.d.ts)
|
||||
|
||||
:::
|
||||
|
||||
@@ -26,9 +26,9 @@ var art = new Artplayer({
|
||||
|
||||
## Importing Languages
|
||||
|
||||
Language files before bundling are located at: `artplayer/src/i18n/*.js`. Contributions to add your language are welcome.
|
||||
Language files before bundling are located at: `artplayer/src/i18n/*.js`. Contributions for new languages are welcome.
|
||||
|
||||
Language files after bundling are located at: `artplayer/dist/i18n/*.js`
|
||||
Bundled language files are located at: `artplayer/dist/i18n/*.js`
|
||||
|
||||
::: code-group
|
||||
|
||||
@@ -79,7 +79,7 @@ var art = new Artplayer({
|
||||
});
|
||||
```
|
||||
|
||||
## Modifying Languages
|
||||
## Modifying a Language
|
||||
|
||||
```js
|
||||
import zhTw from 'artplayer/i18n/zh-tw';
|
||||
|
||||
Reference in new issue
Block a user