From 39035d40016bf3a997e6e5208a2382dcf0f0725b Mon Sep 17 00:00:00 2001 From: torcado194 Date: Sun, 20 Mar 2022 21:15:38 -0400 Subject: [PATCH] fix text --- README.md | 119 +++++++++++++++++++++++++++--------------------------- 1 file changed, 59 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 7af4a8c..55925c9 100644 --- a/README.md +++ b/README.md @@ -79,11 +79,10 @@ And that's it! you can upload the files to your website, or zip them up and uplo `title` (optional) > Text at the top of the player > `"title": "My Album"` -> \ `media` -> List of media files to include in the player +> List of media files to include in the player > ```json > "media": [ > {"file": "track1.mp3", "title": "Track 1"}, @@ -92,110 +91,110 @@ And that's it! you can upload the files to your website, or zip them up and uplo > ``` \ -`cover` (optional) -> The name of the file in the /media folder for the cover image +`cover` (optional) +> The name of the file in the /media folder for the cover image \ -`description` (optional) -> The text at the bottom of the player +`description` (optional) +> The text at the bottom of the player \ -`theme` (optional) -> An object containing theme settings and colors +`theme` (optional) +> An object containing theme settings and colors \ **media entry options** -`file` -> The name of the file in the /media folder +`file` +> The name of the file in the /media folder \ -`title` (optional) -> The name shown for this entry in the player. -> Defaults to the file name if not specified +`title` (optional) +> The name shown for this entry in the player. +> Defaults to the file name if not specified \ -`featured` (optional) -> If `true`, sets this file as the "featured" track, which will queue up first when loading the page. -> Can be either `true` or `false` +`featured` (optional) +> If `true`, sets this file as the "featured" track, which will queue up first when loading the page. +> Can be either `true` or `false` \ -`type` (optional) -> The type of the media. -> Can be either `"audio"` or `"video"` -> Defaults to "audio" +`type` (optional) +> The type of the media. +> Can be either `"audio"` or `"video"` +> Defaults to "audio" \ -`info` (optional) -> Extra text for this file, such as for lyrics or artist attributions. This will be optionally shown over/under the cover image, or togglable below the track. +`info` (optional) +> Extra text for this file, such as for lyrics or artist attributions. This will be optionally shown over/under the cover image, or togglable below the track. \ **theme options** *all settings are optional. Colors can be any valid CSS color* -`titleStyle` -> Styles the title text, if available. -> `"none"` (default) no styling -> `"span"` title spans the entire width, centered. +`titleStyle` +> Styles the title text, if available. +> `"none"` (default) no styling +> `"span"` title spans the entire width, centered. \ -`backgroundColor` -> Color of the page background +`backgroundColor` +> Color of the page background \ -`primaryColor` -> Color of the controls +`primaryColor` +> Color of the controls \ -`primaryAltColor` -> Color of e.g. the unfilled section of the progress bar and volume bar +`primaryAltColor` +> Color of e.g. the unfilled section of the progress bar and volume bar \ -`secondaryColor` -> Secondary color of the controls (e.g. the triangle of the play button) +`secondaryColor` +> Secondary color of the controls (e.g. the triangle of the play button) \ -`highlightColor` -> Background color of the selected track +`highlightColor` +> Background color of the selected track \ -`primaryTextColor` -> Color of most text (e.g. titles, description, info, etc.) +`primaryTextColor` +> Color of most text (e.g. titles, description, info, etc.) \ -`primaryAltTextColor` -> Color of e.g. the track numbers and duration, and the track info button +`primaryAltTextColor` +> Color of e.g. the track numbers and duration, and the track info button \ -`linkColor` -> Text color of links +`linkColor` +> Text color of links \ -`layoutStyle` -> Styles the overall structure of the player -> `"horizontal"` (default) the cover image sits to the right of the player controls and track list -> `"vertical"` all elements aligned vertically, title -> cover -> controls -> track list +`layoutStyle` +> Styles the overall structure of the player +> `"horizontal"` (default) the cover image sits to the right of the player controls and track list +> `"vertical"` all elements aligned vertically, title -> cover -> controls -> track list \ -`infoStyle` -> Styles the track info of the currently playing track -> `"overlaid"` (default) text sits on top of the cover image -> `"below"` text sits below the cover image (note: this will push down the controls and track list in a vertical layout) +`infoStyle` +> Styles the track info of the currently playing track +> `"overlaid"` (default) text sits on top of the cover image +> `"below"` text sits below the cover image (note: this will push down the controls and track list in a vertical layout) \ -`contentWidth` -> Width of the column containing the controls, track list, and description +`contentWidth` +> Width of the column containing the controls, track list, and description \ -`coverSize` -> Width of the cover image (non-square images will scale accordingly) +`coverSize` +> Width of the cover image (non-square images will scale accordingly) \ -`nativePlayer` -> Changes the player controls -> `false` (default) custom player controls -> `true` uses the browser's default audio player (also hides the player when a video is playing, the video's default controls will be available) +`nativePlayer` +> Changes the player controls +> `false` (default) custom player controls +> `true` uses the browser's default audio player (also hides the player when a video is playing, the video's default controls will be available) \ -`customCSS` -> Custom changes to the page's CSS \ No newline at end of file +`customCSS` +> Custom changes to the page's CSS \ No newline at end of file