From 8a381ba0b464d3b289cdcd7b972c65a5f3cd7f98 Mon Sep 17 00:00:00 2001 From: Rishi Giri Date: Mon, 15 Mar 2021 21:57:20 +0530 Subject: [PATCH] doc: minor enhancements (#3222) --- docs/tutorials/basic-usage.md | 12 ++++++------ docs/tutorials/config.md | 4 ++-- docs/tutorials/ui-customization.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/tutorials/basic-usage.md b/docs/tutorials/basic-usage.md index 1a3c63a3a..02669f4a3 100644 --- a/docs/tutorials/basic-usage.md +++ b/docs/tutorials/basic-usage.md @@ -4,12 +4,12 @@ Basic usage of Shaka Player is very easy: 1. Start with {@tutorial welcome} and compile the library. 2. Create a simple HTML page with a video or audio element. -3. In your application's JavaScript: - 1. Install Shaka's polyfills. - 2. Check for browser support. - 3. Create a Player object to wrap the media element. - 4. Listen for errors. - 5. Load a manifest. +3. In your application's JavaScript - + 1. Install Shaka's polyfills. + 2. Check for browser support. + 3. Create a Player object to wrap the media element. + 4. Listen for errors. + 5. Load a manifest. ```html diff --git a/docs/tutorials/config.md b/docs/tutorials/config.md index 523c91863..9d655e77d 100644 --- a/docs/tutorials/config.md +++ b/docs/tutorials/config.md @@ -3,14 +3,14 @@ The goal of this tutorial is to introduce Shaka's configuration system and the concepts on which it is built. More detail can be found in the API docs. -Shaka's Player object has a hierarchical configuration. The overall player +Shaka's `Player` object has a hierarchical configuration. The overall player config contains sub-configs for various parts of the system, such as manifests, streaming, and DRM. To see the current config, you can use `player.getConfiguration()`. If you run this without setting anything first, you get the default configuration. -Player also has a `configure()` method that takes it's argument(s) in one of two +`Player` also has a `configure()` method that takes it's argument(s) in one of two forms: 1. A plain, anonymous object. Any fields you leave out of the config object diff --git a/docs/tutorials/ui-customization.md b/docs/tutorials/ui-customization.md index 5786af83f..abd797d0a 100644 --- a/docs/tutorials/ui-customization.md +++ b/docs/tutorials/ui-customization.md @@ -12,7 +12,7 @@ basic usage tutorial, after creating the UI overlay: const video = document.getElementById('video'); const ui = video['ui']; const config = { - addSeekBar: false; + addSeekBar: false }; ui.configure(config); ```