// Tutorial //

Defining Twitter Cards in your Jekyll Template

Published on June 24, 2016
Default avatar
By Alligator.io
Developer and author at DigitalOcean.
Defining Twitter Cards in your Jekyll Template

While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

Twitter cards are a great way to have your content highlighted when Twitted. There are a few formats available, with Summary /w Large Image being my favorite. Here’s how I defined it in Jekyll in my head.html include file:

<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@alligatorio">
<meta name="twitter:title" content="{{ page.title }}">

{% if page.description %}
  <meta name="twitter:description"
    content="{{ page.meta_description }}">
{% else %}
  <meta name="twitter:description"
    content="{{ page.content | strip_html | xml_escape
      | truncate: 200 }}">
{% endif %}

A few notes

If there’s no meta description defined for the page, we pull the first 200 words of the post using some Jekyll template filters. Thanks to Paul Stamatiou for the trick. If there’s no thumbnail defined for the post, we pull a general cover image for the site.

You’ll obviously want to change the twitter:site to reflect the Twitter handle for your site. If needed, you can also define a twitter:creator with the content set to the Twitter handle of the author of the specific post. Maybe for this you could see if an author is defined in the Jekyll Front Matter for the post.

Validating your cards

You can use this tool to validate your Twitter cards. For the Summary Card with Large Image type, twitter:card, twitter:site, twitter:title and twitter:description are required.

Want to learn more? Join the DigitalOcean Community!

Join our DigitalOcean community of over a million developers for free! Get help and share knowledge in our Questions & Answers section, find tutorials and tools that will help you grow as a developer and scale your project or business, and subscribe to topics of interest.

Sign up
About the authors
Default avatar
Developer and author at DigitalOcean.

Still looking for an answer?

Was this helpful?
Leave a comment

This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!