Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trovster/commonmark-ext-spotify-iframe
Extension for league/commonmark to replace Spotify link with an iframe.
https://github.com/trovster/commonmark-ext-spotify-iframe
commonmark extension iframe markdown php spotify
Last synced: 3 days ago
JSON representation
Extension for league/commonmark to replace Spotify link with an iframe.
- Host: GitHub
- URL: https://github.com/trovster/commonmark-ext-spotify-iframe
- Owner: trovster
- License: mit
- Created: 2022-04-08T11:35:49.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-06T14:03:27.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T02:19:47.366Z (16 days ago)
- Topics: commonmark, extension, iframe, markdown, php, spotify
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Spotify iframe extension
An extension for [league/commonmark](https://github.com/thephpleague/commonmark)
version 2 built using PHP 8.0. This replaces Spotify links with the embed iframe.
The extension supports for tracks, artists, albums and playlists using the embed
URL format.
Initially based on the [YouTube extension](https://github.com/zoonru/commonmark-ext-youtube-iframe).
## Installation
The project should be installed via Composer:
```bash
composer require surface/commonmark-ext-spotify-iframe
```
## Usage
Configure your CommonMark `Environment` and add the extension.
```php
use League\CommonMark\Environment\Environment;
use League\CommonMark\MarkdownConverter as Converter;
use Surface\CommonMark\Ext\SpotifyIframe\Extension as SpotifyExtension;
$options = [
'spotify_iframe' => [
'size' => 'large',
],
];
$environment = new Environment($options);
$environment->addExtension(new SpotifyExtension());
$converter = new Converter($environment);
echo $converter->convert('[](https://open.spotify.com/embed/artist/xxx)');
echo $converter->convert('[](https://open.spotify.com/embed/track/xxx?theme=0)');
echo $converter->convert('[](https://open.spotify.com/embed/album/xxx?theme=1&size=small)');
echo $converter->convert('[](https://open.spotify.com/embed/playlist/xxx?theme=1&size=lg)');
```
### Sizes
Spotify provides two different sizes, `large` and `small`. By default the
extension provides the `large` version. You can configure the option globally
using the `size` option.
You can also configure the *size* option using a query parameter on the embed
URL. The supported sizes are `large`, `lg`, `small` and `sm`.
```html
?size=large
?size=small
?size=lg
?size=sm
```
## Testing
There are Unit and Integration tests for the project. These can be run using
the following commands:
```bash
composer test
composer run test
composer run test-unit
composer run test-integration
```
There are also scripts to run code sniffer, mess detector and static analysis:
```bash
composer run sniff
composer run mess
composer run stan
```
## Changelog
Please refer to the [CHANGELOG](CHANGELOG.md) for more information on what has
changed recently.
## License
This library is licensed under the MIT license. See the
[License File](LICENSE.md) for more information.