Rework markup SC player

[api-platform]

Rework markup SC player

[dunglas]

Indeed it's a bug, we should do that!

[lex111]

You mind if I handle this two bugs, okay?

[dunglas]

You're very welcome!

[lex111]

I suggest making the markup more semantic, like this:

<figure class="symfonycasts"><a href="#"><img src="#" alt="#"><figcaption>Optional caption</figcaption></a></figure>

It's good for you?

[dunglas]

Yes it's even better!

[lex111]

Hmm, I just thought that we can simplify the insertion SC block a bit, I mean use something like shortcode.
For example, symfonycasts:alt="JWT screencast" link="https://symfonycasts.com/tracks/rest?cid=apip#api-platform" transforms to HTML!

<p class="symfonycasts"><a href="https://symfonycasts.com/tracks/rest?cid=apip#api-platform" class="symfonycasts"><img src="../distribution/images/symfonycasts-player.png" alt="JWT screencast"></a></span></p>

How does that sound?

[dunglas]

Will it work when browsing the doc files directly in GitHub? Also, Everywhere else we have a caption at the bottom of the player.

[lex111]

Will it work when browsing the doc files directly in GitHub?

Um, nope, but is that really important? I mean, who reads the documentation on GitHub? I think you can give that up.

Also, Everywhere else we have a caption at the bottom of the player.

Of course, caption can be provided, this is a concept, I did not just specify it.

[dunglas]

Many people read the docs directly from GH, or from their IDE. I think we should stick to standard markdown

[lex111]

Hmm, really a pity, all the more it is a valid inline code and by its contents you can understand what it represents. And we could significantly simplify the insertion of SC block, but for some reason we manually duplicate the code each time...

Nevertheless, it is strange that in reality many people read the docs on GH, it’s at least inconvenient, and it’s faster to open a website with documentation. So this is a moot point, as for me.

Well, those who look at the docs from their IDE are just the developers who do this only to edit the docs, especially considering the separate docs repository.