Updated documtnation to support carbon ads and sponsors

danpastori · danpastori · commit 1744f0fe5727 · 2020-05-29T11:45:45.000-07:00
diff --git a/docs/README.md b/docs/README.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Overview
+<carbon-ads/>
 The concept of Amplitude.js is simple, allow designers to fully control the look
 and feel of their audio player through the web without having to understand
 advanced scripting. In HTML5, the audio tag allows users to add common audio
diff --git a/docs/configuration/README.md b/docs/configuration/README.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Configuring Amplitude.js
+<carbon-ads/>
 Amplitude JS contains many variables that can be configured to determine the
 functionality of AmplitudeJS.
 
diff --git a/docs/configuration/binding-key-events.md b/docs/configuration/binding-key-events.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Binding Key Events
+<carbon-ads/>
 This allows you to configure certain
 events to trigger on key presses. The main piece of information needed is the
 key code [https://keycode.info/](https://keycode.info/). Once you have that, you
diff --git a/docs/configuration/callbacks.md b/docs/configuration/callbacks.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Callbacks
+<carbon-ads/>
 There are a variety of callbacks specific to AmplitudeJS that get called at certain times that the developer can bind to.
 
 
diff --git a/docs/configuration/continue-next.md b/docs/configuration/continue-next.md
@@ -35,6 +35,8 @@ meta:
     content: "@521dimensions"
 ---
 
+<carbon-ads/>
+
 AmplitudeJS allows you to stop playing a song after it has been finished. To stop a song after it has been finished playing you need to configure AmplitudeJS with the `continue_next` flag set to `false` on initialization. By default, AmplitudeJS will go to the next song in the list or playlist depending on state. To set the flag as false, initialize AmplitudeJS with the following parameter:
 
 ```javascript
diff --git a/docs/configuration/debug.md b/docs/configuration/debug.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Debug Mode
-
+<carbon-ads/>
 Debug mode outputs verbose updates when Amplitude actions take place to see the
 current config and statuses of the AmplitudeJS player. To turn on AmplitudeJS
 debug mode you can set it in the config or call:
diff --git a/docs/configuration/default-art.md b/docs/configuration/default-art.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Default Art
-
+<carbon-ads/>
 If you have audio that doesn't have a specific piece of album art, you can define
 a default image url using the "default_album_art" key. The value can be set on initialization or through a public method. You can also set the default playlist art for metadata. If you don't define a piece of album art for your playlist you can also set that on initialization through the "default_playlist_art" key or through a public method.
 
diff --git a/docs/configuration/delay.md b/docs/configuration/delay.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Delay Between Audio
-
+<carbon-ads/>
 AmplitudeJS allows the developer to add a time delay between the audio objects defined. By default, this value is `0`. When you initialize AmplitudeJS you can provide an integer in MS for how long you want AmplitudeJS to wait before it starts playing the next audio track.
 
 ## Initialization
diff --git a/docs/configuration/installation.md b/docs/configuration/installation.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Installation
-
+<carbon-ads/>
 ## Option 1: Use CDN from jsDelivr
 No installation is required to use Amplitude.js. All you need to do is include a single line in your `<head>` section of your HTML page.
 
diff --git a/docs/configuration/playback-speed.md b/docs/configuration/playback-speed.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Setting the Default Playback Speed
-
+<carbon-ads/>
 By default, AmplitudeJS plays back the audio at the normal speed of `1.0`. However, you can initialize AmplitudeJS to play at `1.5`x the normal rate or `2.0`x times the normal rate. To do that, you can set the `playback_speed` attribute on initialization.
 
 ```javascript
diff --git a/docs/configuration/playlists.md b/docs/configuration/playlists.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Playlists
-
+<carbon-ads/>
 Using playlists is an essential piece of functionality for AmplitudeJS. As a developer you have the ability to group audio by playlists. There are multiple advantages to this such as the ability to display unique groupings on the screen at once. A playlist could be an album, a group of songs, a podcast series, etc. It's all up to you on how you want to do it!
 
 There are multiple ways to initialize playlists. Let's start with doing it right away in the `Amplitude.init()` method.
diff --git a/docs/configuration/shuffle.md b/docs/configuration/shuffle.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Defaulting Shuffle On
-
+<carbon-ads/>
 You can turn shuffle on right away when initializing AmplitudeJS. To do that, simply initialize AmplitudeJS with the `shuffle_on` parameter like this:
 
 ```javascript
diff --git a/docs/configuration/song-objects.md b/docs/configuration/song-objects.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Song Objects
-
+<carbon-ads/>
 An array of JSON song objects is required by AmplitudeJS.  This directs
 AmplitudeJS to the metadata and information necessary for playing the audio.
 
diff --git a/docs/configuration/soundcloud-configuration.md b/docs/configuration/soundcloud-configuration.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Soundcloud Configuration
+<carbon-ads/>
 AmplitudeJS supports SoundCloud integration! To use SoundCloud there are a couple parameters that need to be set.
 
 First, the `url` in your song object must be the SoundCloud URL of the song provided. Second, the artist must have their audio be able to be streamed. NOT ALL AUDIO ON SOUNDCLOUD IS STREAMABLE! This is up to the artist to allow the song to be streamed through their API. If they do not allow it, the audio will not be able to be streamed!
diff --git a/docs/configuration/start-song-start-playlist.md b/docs/configuration/start-song-start-playlist.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Setting the Starting Audio and Starting Playlist
-
+<carbon-ads/>
 When you initialize AmplitudeJS you can instruct AmplitudeJS to start at a certain song, certain playlist, and a certain song in a playlist.
 
 ## Set Starting Song
diff --git a/docs/configuration/volume.md b/docs/configuration/volume.md
@@ -35,7 +35,7 @@ meta:
     content: "@521dimensions"
 ---
 # Configuring Default Volume Parameters
-
+<carbon-ads/>
 There are lots of different volume parameters that can be set by default in AmplitudeJS. You can initialize the volume to be
 
 ## Setting the Starting Volume
diff --git a/docs/contributing/README.md b/docs/contributing/README.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # How to contribute to AmplitudeJS
+<carbon-ads/>
 We greatly appeciate any efforts to help grow and maintain the AmplitudeJS community! There are number of ways that you can help AmplitudeJS:
 
 ## Share us on social media
diff --git a/docs/elements/README.md b/docs/elements/README.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Elements Introduction
-
+<carbon-ads/>
 AmplitudeJS comes with a variety of elements. Each element is picked up by a
 class prefixed with 'amplitude-' and depending on the environment, an attribute
 that relates to the index of a song in your list of songs or a playlist you are
diff --git a/docs/elements/interactive-elements.md b/docs/elements/interactive-elements.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Interactive Elements
-
+<carbon-ads/>
 The interactive elements of AmplitudeJS have event handlers bound to them that
 responds to a touch or click from a user. These elements build the functionality
 of the player you are designing. The scoping of these elements is handled by
diff --git a/docs/elements/metadata-elements.md b/docs/elements/metadata-elements.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Meta Data Elements
-
+<carbon-ads/>
 Meta data elements get their information filled in with meta data from the
 active song object or on initialization from the keyed song in the array. These can be any type of HTML element except when filling
 in cover_art_url, station_art_url, or podcast_episode_cover_art_url.
diff --git a/docs/functions/README.md b/docs/functions/README.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 # Public Functions
+<carbon-ads/>
 There are a variety of public functions that AmplitudeJS exposes to the user.
 These methods allow the user to change config variables, add new songs, play
 now, etc.
diff --git a/docs/fx/README.md b/docs/fx/README.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # FX Introduction
-
+<carbon-ads/>
 Amplitude FX elements are a brand new feature that requires a special section. These elements include Waveforms and Visualizations for audio. These elements make use of the Web Audio API providing more power to fine tune your player and create beautiful web audio players! Since these players make use of the Web Audio API it's important to realize that the browser they run in has to support it: [https://caniuse.com/#feat=audio-api](https://caniuse.com/#feat=audio-api).
 
 As of this writing, most major browsers (besides IE 11 go figure) support it. If it's not supported, we simply won't use the Web Audio API in your player.
diff --git a/docs/fx/visualizations.md b/docs/fx/visualizations.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Overview of Visualizations
-
+<carbon-ads/>
 So what are audio Visualizations? They are the beautiful art that vibe to the beat and react to the different highs and lows of the songs. iTunes is famous for having a beautiful visualization for it's audio.
 
 In AmplitudeJS you can add your own visualization element to the page that operates the same as an iTunes visualization! It reads in the highs and lows and different frequencies of the song to generate a beautiful visual to go along with the music! If you are really motivated, you can build your own using the template provided.
diff --git a/docs/fx/waveforms.md b/docs/fx/waveforms.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Overview of Waveforms
-
+<carbon-ads/>
 Waveforms are another FX element added to AmplitudeJS. A waveform is a visual representation of the sound compressions for a piece of audio. Using the Web Audio API, you can display these in your player.
 
 There is one parameter that you can set to determine how your waveforms are displayed and that is the `sample_rate` set on initialization. The `sample_rate` setting determines how "fine" the visual for the waveform should be. The lower the sample rate, the more "rough" a depiction is generated. The higher the sample rate the more "accurate" a depiction is generated. Now keep in mind, the higher the sample rate, the more memory and longer it will take to generate!
diff --git a/docs/help-and-support/README.md b/docs/help-and-support/README.md
@@ -36,6 +36,7 @@ meta:
 ---
 
 ## Community Support
+<carbon-ads/>
 Since AmplitudeJS is open sourced under the MIT license, any participating member can assist you with your support question. [Learn more about Community Support &rarr;](https://521dimensions.com/open-source/amplitudejs/docs/get-help/#community-support)
 
 ## Professional Support
diff --git a/docs/installation/README.md b/docs/installation/README.md
@@ -35,7 +35,7 @@ meta:
     content: "@521dimensions"
 ---
 # Installation
-
+<carbon-ads/>
 ## Option 1: Use CDN from [jsDelivr](https://cdn.jsdelivr.net/npm/amplitudejs/)
 No installation is required to use Amplitude.js. All you need to do is include a single line in your `<head>` section of your HTML page.
 
diff --git a/docs/installation/initialization.md b/docs/installation/initialization.md
@@ -35,6 +35,7 @@ meta:
     content: "@521dimensions"
 ---
 # Initializing Amplitude.js
+<carbon-ads/>
 To initialize Amplitude.js, you must call the `Amplitude.init()` method and pass in an object that contains an array of songs and settings. Amplitude.js will then take care of configuring and setting up your player by finding all of the Amplitude elements (defined later in the docs) and binding the appropriate event handlers.
 
 To configure Amplitude.js, you need to call the init function on the Amplitude object and you can pass it a JSON object of configuration variables ( we will go through ALL of these in the documentation ). At the bare minimum, you need to pass it all of the song objects that your page will be using. More information about the song object next.
diff --git a/docs/migrations/README.md b/docs/migrations/README.md
@@ -36,7 +36,7 @@ meta:
 ---
 
 # Upgrading from 3.x To 4.0
-
+<carbon-ads/>
 AmplitudeJS 4.0 was one of the biggest releases thus far. We tried to limit the breaking changes, but in order to scale for the future we had to make a few.  I should have every change documented below and the reason why the change was made.
 
 ## All AmplitudeJS Attributes Have HTML5 Dataset Prefix
