ipfs-docs icon indicating copy to clipboard operation
ipfs-docs copied to clipboard

OG tags needed across the docs website

Open damedoteth opened this issue 2 years ago • 5 comments

When sharing a link to a docs page on social media, there is no preview card displayed — ideally a card would appear that displays the page's title, description, image, etc. @2color

damedoteth avatar Feb 09 '23 17:02 damedoteth

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.tech if you just need general support.

welcome[bot] avatar Feb 09 '23 17:02 welcome[bot]

@damedoteth I'm actually not sure if this is possible in vuepress

@johnnymatthews any thoughts on this?

ElPaisano avatar Aug 07 '23 01:08 ElPaisano

@ElPaisano I wonder if front matter would work? https://v1.vuepress.vuejs.org/guide/frontmatter.html

damedoteth avatar Aug 07 '23 11:08 damedoteth

Yeah this is doable. We just need to add something like this to the header of each page:

<meta property="og:title" content="Installing IPFS">
<meta property="og:type" content="article" />
<meta property="og:description" content="A step-by-step guide for installing IPFS on your toaster.">
<meta property="og:image" content="https://docs.ipfs.tech/toaster/install.png">
<meta property="og:url" content="https://docs.ipfs.tech/toaster/install.html">
<meta name="twitter:card" content="install.png">

We could grab all this from the front-matter, expect the images which would likely come from some specific image used for all social cards.

While not overly complex, I'd wager the priority of something like this isn't particularly high. If someone from the community wants to pick this up though, this would be a nice addition to the docs.

johnnymatthews avatar Aug 10 '23 13:08 johnnymatthews

Agree, not high priority. Now that my skills at using Github are in a good place I may attempt to work on this some. Will post here though if/when I do start on that so that others are aware.

damedoteth avatar Aug 10 '23 14:08 damedoteth