Static Twitter timeline for Hugo

I made this plugin for Hugo because I wanted a way to embed my own Twitter timeline on my blog without having to load any external scripts or images. All it does is fetch the tweets via Twitter's own API and render them on each hugo build.

Note: It's important to run hugo build with the --ignoreCache parameter, otherwise fresh tweets won't show up, as the API responses get cached.

Prerequisites

You will first need to obtain an OAuth 2.0 Bearer (app-only) token from Twitter. For this you will need a developer account and an application.

Once you have this token, you will need to make it accessible as an environment variable called HUGO_TWITTER_API_TOKEN for the hugo executable. There are plenty of guides online on how to do that for your operating system of choice, so I won't repeat that information here.

How to install

1. Download this repository into your /themes directory, or add it as a Git submodule:

   git submodule add [email protected]:victorstanciu/hugo-tweets.git themes/hugo-tweets
   

2. Edit your config.toml, config.yaml, or config.json file to load the theme before your other theme(s):

   theme = ["hugo-tweets", "minima"]
   

3. Load or paste the CSS file into your theme. Don't mind the .scss extension, that's just to give SASS/SCSS users the option of import-ing the file, the code is otherwise plain CSS.

How to embed

There are two ways to embed the timeline:

• As a shortcode (in /content/*.md files):

  {{< stimeline username="[USERNAME]" results=10 >}}
  

• As a partial (in /layout/*.html files):

  {{ .Scratch.Set "twitter_username" "[USERNAME]" }}
  {{ .Scratch.Set "twitter_results" 10 }}
  {{ partial "stimeline.html" . }}