Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Open Graph protocol and link sharing

See original GitHub issue

It would be cool if there was a configuration option to support Open Graph protocol or Twitter cards when sharing examples:

Open Graph protocol: “enables any web page to become a rich object in a social graph.”
Twitter Cards: “… you can attach rich photos, videos and media experiences to Tweets.”

I think this could be accomplished by adding relevant meta tags to the head when generating pages.

Some examples for how this might look

Current version

Using scikit-learn as an example, sharing the linear_model and plot_comparison pages on Slack results in the following:

But the generated image, description, and a few other things could also be part of this.

Possible version

Now using this web page as an example, sharing a link results in:

… because of the following meta tags:

<!-- Open Graph -->
<meta property="og:locale" content="en">
<meta property="og:type" content="article">
<meta property="og:title" content="LaTeX Finite Automata and State Diagrams with Tikz">
<meta property="og:description" content="This short guide collects some examples of drawing finite state machines using the Tikz LaTeX library.">
<meta property="og:url" content="https://hayesall.com/blog/latex-automata/">

Other notes

OPG support might be incorporated elsewhere (e.g. sphinx-contrib/ogp).
Here’s a liquid template for generating some of these: https://github.com/hayesall/hayesall.github.io/blob/fee47f82f5cb489f14cbe8018cf812733670138c/_includes/open-graph.html

Issue Analytics

State:
Created 3 years ago
Reactions:1
Comments:13 (8 by maintainers)

Top GitHub Comments

2reactions

rowanc1commented, Jun 16, 2020

I believe that the meta tags have to be in the head (at least last time I did this) as well as in the static server rendered html. There is a nice way to check that they are working across sites here:

https://metatags.io/

If helpful, this is what I use on my sites: https://github.com/iooxa/iooxa-dev/blob/master/src/partials/meta.tpl

2reactions

choldgrafcommented, Jun 11, 2020

I think the one thing we should double-check is that meta tags for opengraph work outside of the <head> of a page. If they do, then I think this is a good idea. If they don’t, then it might be trickier to get this working across different themes