Recently I've been cleaning up old articles when I stumbled upon a problem with dead links. Some of the articles written 1-2 years ago were linking to non-existing pages. This post will describe a pelican plugin to notify or/and deal with said issues.

Any feedback is more than welcome!

Requirements

Plugin should work on both Python 2.7 and 3.5. Additionally it requires following libraries:

• BeautifulSoup4

Installation

Clone repository from one of the possible sources:

• Directly from https://github.com/silentlamb/pelican-deadlinks
• From a master branch of https://github.com/getpelican/pelican-plugins

Let's assume destination is ./plugins/custom/deadlinks. Configuration file should be changed as follow:

PLUGINS_PATH = [
    # [...]
    'plugins/custom'
]
PLUGINS = [
     # [...]
    'deadlinks'
]

Or if you happen to use pelican-plugins directly, pull recent master.

Settings

To enable dead link checker, set the DEADLINK_VALIDATE option in your Pelican configuration file to True. Additionally following options might be changed:

DEADLINK_OPTS = {
    'archive':  True,
    'classes': ['custom-class1', 'disabled'],
    'labels':   True
}

Licence

MIT