jekyll-crosspost-to-medium

jekyll-crosspost-to-medium

A Jekyll generator for automatically crossposting to Medium

Download

This project is in search of a new sponsor as the author is no longer using Jekyll.

Crosspost to Medium Generator for Jekyll and Octopress

This plugin makes it possible to automatically syndicate your posts to Medium from your Jekyll and Octopress projects.

Setup

  1. Sign up for a Medium account (if you don’t already have one). Log in.
  2. Request access to the "integration tokens" settings by emailing yourfriends@medium.com. Medium will then grant you access to a clientId and a clientSecret on your settings page. Read their API docs for more information
  3. Go to your settings page and look for "Integration Tokens". Generate one. Save it to your Environment Variables as MEDIUM_INTEGRATION_TOKEN.
  4. Visit https://api.medium.com/v1/me?accessToken=, adding your Integration Token to the end of that URL
  5. Grab the id from the JSON provided and save that to your Environment Variables as MEDIUM_USER_ID.
  6. Copy jekyll-crosspost-to-medium.rb to your site’s plugins folder.

Installation

This plugin can be installed in two ways:

  1. As a Ruby Gem: gem install jekyll-crosspost-to-medium
    • Via _config.yml add jekyll-crosspost-to-medium to your gems list; or
    • Add require 'jekyll-crosspost-to-medium' to ext.rb in your plugins directory (new or existing one)
  2. By directly copying jekyll-crosspost-to-medium.rb (found in the lib directory) into your plugins directory.

Crossposting

Add crosspost_to_medium: true to the front matter of any post you would like to crosspost to Medium.

Configuation

This plugin takes a number of configuration options. These allow you to customise how the plugin works and what metadata is included when you syndicate to Medium. The following options are available:

jekyll-crosspost_to_medium:
  enabled: true | false
  cache: .jekyll-crosspost_to_medium
  status: public (default) | draft | unlisted
  license: all-rights-reserved (default) | cc-40-by | cc-40-by-sa | cc-40-by-nd | cc-40-by-nc | cc-40-by-nc-nd | cc-40-by-nc-sa | cc-40-zero | public-domain
  text: '<p><i>Your (optional) signoff for the post.</i></p>',
  backdate: true (default) | false

  • enabled

    Default: true

    Controls crossposting globally. Setting this to false will skip the processing loop entirely which can be useful for local preview builds.

  • cache

    Default: [source directory]/.jekyll-crosspost_to_medium

    The name of the diretory where crossposted files will be logged. Make sure this file gets checked into your Git repo if you work from multiple computers. This will ensure you never crosspost an entry more than once.

  • status

    Default: public

    The status your post is given when it is syndicated to Medium.

  • license

    Default: all-rights-reserved

    The license your post is given when it is syndicated to Medium.

  • text

    Default: <p><i>This article was originally posted <a href="{{ url }}" rel="canonical">on my own site</a>.</i></p>

    Optionally, provide a string to override the default text for the canonical link back to the source post. A {{ url }} placeholder should be provided to indicate where to put the canonical link, e.g., Some <a href="{{ url }}">link</a>

  • backdate

    Default: true

    Whether or not to use the original date & time of publication when crossposting.

A Note on Environment Variables

If you are having problems setting up Environment Variables, check out these guides:

Credits

Many thanks to Jeremy Keith for sharing his process (and PHP code) for getting this working on his own site.

minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog