search

ponylang / pony-tutorial

:horse: Tutorial for the Pony programming language
http://tutorial.ponylang.io
BSD 2-Clause "Simplified" License
308 stars 111 forks source link

Meta Tags, OpenGraph and Twitter Cards #546

Closed shaedrich closed 4 months ago

shaedrich commented 5 months ago

Wouldn't it be nice, if the ponylang sites had OpenGraph and such? This could be done via the meta plugin (squidfunk docs, Python Markdown docs) and by extending the theme.

SeanTAllen commented 5 months ago

As the person who ends up doing most of the support, I'm not interested in doing overrides without a compelling reason.

What's the compelling reason here in your mind?

shaedrich commented 5 months ago

So, you are okay with sharing a link and getting no preview? Or being a site that doesn't offer that to others sharing the link? I think, this is considered a de facto standard by now

SeanTAllen commented 5 months ago

I'm ok with sharing links and going no preview. If there's no ongoing support overhead then having them sounds fine but I don't personally consider it compelling nor something I would want to do extra to support going forward. Whereas the awesome work you've been doing on making examples runnable in the playground and having it so we can compile them to make sure they stay up to date with compiler changes, that is very very compelling and something I'll happily spend maintenance time on in the future.

What's the level of "this is custom and might break" involved with the previews?

shaedrich commented 5 months ago

If there's no ongoing support overhead then having them sounds fine but I don't personally consider it compelling nor something I would want to do extra to support going forward. […] What's the level of "this is custom and might break" involved with the previews?

First, this is not some kind of customization only we would do but a lot of sites, as this is a pretty common use case. Having <meta> HTML tags in the <head> section is something that won't go away anytime soon. Parsing YAML frontmatters in Markdown files is also a very common markdown feature. Sure, I don't know what mkdocs envisions in terms of breaking changes, but assuming, they progress reasonable, I don't see many problems ahead. Sure, the meta might become deprecated in the future (highly hypothetical and not overly expectable), but we could bridge that gap fairly easy and the base conditions for us wouldn't change significantly

Whereas the awesome work you've been doing on making examples runnable in the playground

Thanks :)

SeanTAllen commented 5 months ago

I'm specifically concerned with "extending the theme". What is involved? How likely is it to break going forward.

shaedrich commented 5 months ago

That's why I included the link. But I can add a proof of concept PR to show you what we would have to change if that's easier to visualize and decide for you.

SeanTAllen commented 4 months ago

We discussed further and this additional maintenance work for this and having to come up with descriptions, keep up to date etc isn't something we want to take on. We are ok with things being posted on twitter and elsewhere that have "bare links".

shaedrich commented 4 months ago

Understood.