Skip to main content

Find all the broken links in your Lektor site!

Project description

Broken Links

Find all the broken links!

Broken Links helps you detect broken links in your Lektor site.

Currently it's only smart enough to check internal links, but it's considering getting a degree in external link detection.

Goals

  • Fast - Less than 1 second to check sites with hundreds of pages.
  • Simple - Install on your site and it quietly runs on every build.

Getting Started

Broken Links depends on the following packages...

  • mistune >= 0.7.0, <2
  • click >= 7.0
  • furl >= 2.1.0

...which can be easily installed with...

$ pip install mistune click furl

Once dependencies are installed, you can add Broken Links to your Lektor project with...

$ lektor plugins add lektor-broken-links

Alternatively Broken Links can be installed manually by copying the plugin folder into packages/.

Once Broken Links is installed, run lektor build or lektor server. Any broken internal links will be printed in the build output, along with the page they were found on.

broken-links-tests$ lektor build
Started build
Started link check
Found 2 broken links in '/':
    /none
    ./none
Found 1 broken link in '/nested':
    ../none
Finished link check in 0.02 sec
Finished build in 0.03 sec
Started prune
Finished prune in 0.00 sec

Example output from building the test site.

Contributing

Thank you for your interest in this project! If you find a bug or have an idea for an awesome new feature please open an issue. Pull Requests which help close issues are welcome!

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

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

Files for lektor-broken-links, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size lektor_broken_links-0.1-py3-none-any.whl (4.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size lektor-broken-links-0.1.tar.gz (3.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page