search

carpentries / styles

Styles for The Carpentries lessons. No README to avoid merge conflicts with lessons. Demo 👇
https://carpentries.github.io/lesson-example
Other
84 stars 94 forks source link

OpenGraph details #604

Open mjaquiery opened 3 years ago

mjaquiery commented 3 years ago

Added OpenGraph meta tags, and a logo image to populate them. Included a Twitter card to display in summary format.

The description is taken from the first available of:

The description is truncated to 200 characters.

@zkamvar raised the following points:

  1. The home page shows the schedule with the questions for each episode, but I think it might be better to prioritize keypoints over questions for the metadata since it will often be viewed out of context of the lesson.
    • Questions are used here because they are clearly separated by ? and look quite nice (for the example I used) in the social media preview. Key points may work better for most lessons (perhaps the one I developed with was unusual?). There seems to be a bit of inconsistency over whether questions highlight lesson content or are tangential to the main lesson body. In any case, this should be tweakable in _includes/open-graph.html
  2. I believe we can use the largest mstile favicon instead of uploading a new icon. You can see how these are parsed in _includes/favicons.html (and maybe all of this should go in this particular file since it all goes in the tag.

The new social media rich preview cards for Twitter can be viewed at https://cards-dev.twitter.com/validator Facebook also has one of these, but it requires a Facebook account to access and I don't have one.

The build is failing on my local copy and I don't know why - I don't think I've changed anything that would break a build and the repository doesn't build properly locally for me.

zkamvar commented 3 years ago

The build is failing on my local copy and I don't know why - I don't think I've changed anything that would break a build and the repository doesn't build properly locally for me.

This repository does not build properly on its own, but the automated checks show that it's working, so we're good :)