Find Dead Links on Your Jekyll Blog with HTML Proofer
Introduction
HTML Proofer is a super handy ruby tool that helps you check your statically generated HTML for any inconsistencies. If you have a large statically generated site then it is certainly worth setting this up because as your site continues to grow it will become more and more difficult to audit the validity of your pages. I have used HTML Proofer in the past, but for whatever reason I had "disable_external" set to true which ignored all outgoing links. It is still useful to find things like missing alt tags in images, and general invalid HTML, but this feature makes it a must for all blogs.Configuration
Rather than clicking on every link on every page, let HTML Proofer do the heavy lifting for you with the following simple steps:Install HTML Proofer
Add the following to yourGemfile
gem "html-proofer" gem "rake"
bundle install
Configure a Rake Task
Add the following to yourRakefile
.
require 'html-proofer'task :test do sh “bundle exec jekyll build” HTMLProofer.check_directory("./_site", { :allow_hash_href => true }).run end
Run the Task
bundle exec rake test
* External link https://levlaz.org/tag/lxc/ failed: 404 No error - ./_site/projects/index.html * External link https://ezbadge.levlaz.org/ failed: 301 Peer certificate cannot be authenticated with given CA certificates - ./_site/salting-your-lxc-container-fleet/index.html * image /images/minions.jpg does not have an alt attribute (line 150) - ./_site/setting-up-antlr4-on-windows/index.html * image /images/antlr.png does not have an alt attribute (line 156) * image /images/grun.png does not have an alt attribute (line 163) - ./_site/share-this-on-facebook/index.html
Configure CI
If are using CircleCI you can add the following to yourcircle.yml
to run the proofer automatically.
test: override: - bundle exec rake test
Conclusion
There is nothing worse than clicking on a link and seeing a 404. When the post is from 2013, perhaps you can excuse it, but it is still a terrible experience for the user and as a "web master" you owe it to your users to prevent link rot.Thank you for reading! Share your thoughts with me on bluesky, mastodon, or via email.
Check out some more stuff to read down below.
Most popular posts this month
- Everything wrong with developer tools in a single paragraph
- SQLite DB Migrations with PRAGMA user_version
- Urge to Edit Old Posts
- Setting up ANTLR4 on Windows
- Reinstalling Windows at 1am
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- 21st Century C++ from Communications of the ACM
- Submarines DevCon 2025 Keynote Speech from JoshHaines.com
- How I Use AI: Meet My Promptly Hired Model Intern from Armin Ronacher's Thoughts and Writings
- DeepSeek from Maggie Appleton
- Digital Reality Digital Shock from Christopher Butler
- 10 habits to help becoming a Debian Maintainer from Optimized by Otto
- Tiny corners from Manuel Moreale RSS Feed
- Build It Yourself from Armin Ronacher's Thoughts and Writings
Articles from blogs I follow around the net
“Stop calling it work” – Cedric Raguenaud
Cedric Raguenaud argues that.. “When we label our photographic pursuits as “work,” we unconsciously impose constraints and expectations that belong in the professional world. Suddenly, we feel pressured to maintain visibility, chase originality, and demon…
via Colin Devroe February 10, 2025The Art of Making Websites
Hidde de Vries gave a great talked titled “Creativity cannot be computed” (you can checkout the slides or watch the video). In his slides he has lots of bullet points that attempt to define what art is, and then in the talk he spends time covering each one…
via Jim Nielsen’s Blog February 10, 2025Corporate “DEI” is an imperfect vehicle for deeply meaningful ideals
I have not thought or said much about DEI (Diversity, Equity and Inclusion) over the years. Not because I don’t care about the espoused ideals — I suppose I do, rather a lot — but because corporate DEI efforts have always struck me as ineffective and blan…
via charity.wtf February 10, 2025Generated by openring