Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Meta Tags, OpenGraph and Twitter Cards #546

Open
shaedrich opened this issue May 24, 2024 · 6 comments · May be fixed by #548, ponylang/ponylang-website#1003 or ponylang/pony-patterns#80
Open

Meta Tags, OpenGraph and Twitter Cards #546

shaedrich opened this issue May 24, 2024 · 6 comments · May be fixed by #548, ponylang/ponylang-website#1003 or ponylang/pony-patterns#80
Labels
discuss during sync Should be discussed during an upcoming sync

Comments

@shaedrich
Copy link
Collaborator

shaedrich commented May 24, 2024 •
edited

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.
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label May 24, 2024
@SeanTAllen
Copy link
Member

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
Copy link
Collaborator Author

shaedrich commented May 24, 2024 •
edited

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
Copy link
Member

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
Copy link
Collaborator Author

shaedrich commented May 24, 2024 •
edited

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 :)

@shaedrich shaedrich mentioned this issue May 24, 2024
Closed
@SeanTAllen
Copy link
Member

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

@shaedrich
Copy link
Collaborator Author

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.

This was referenced May 24, 2024
Draft
Draft
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discuss during sync Should be discussed during an upcoming sync
Projects
None yet
Milestone
No milestone
3 participants
@SeanTAllen @shaedrich @ponylang-main