Skip to main content

Plugin for Pelican that computes read time based on Medium's readtime "algorithm."

Project description

Plugin for Pelican that computes read time based on Medium’s readtime “algorithm”. It adds a readtime and readtime_minutes attributes to articles, with the time estimation for reading the article.

Usage

To use it you have to add the plugin name to the pelicanconf.py file.

PLUGINS=[ ... , 'readtime']

Then you can access the readtime variable to show read time estimation on your templates.

{% if article.readtime %} <div>{{ article.readtime }} read</div> {% endif %}

It will generate the following:

<div>X Minutes and Y Seconds read</div>

Alternatively, you can use the readtime_minutes variable to get the number of minutes instead of the fully formatted text.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pelican-readtime, version 0.1.2
Filename, size File type Python version Upload date Hashes
Filename, size pelican-readtime-0.1.2.zip (6.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page