Testing Markdown With CI


#1

TL:DR; I wrote a blog post on testing Markdown files

Hey People,

So I run about 10 small websites all built with Hugo. I also work for CircleCI where our marketing website and CircleCI Docs are built with Jekyll. It’s safe to say I spend a lot of time thinking about building and testing static websites. If you look through my past blog posts you’ll see that I have several posts sharing how to build and test Hugo websites and a colleague wrote about deploying static sites.

A lot of static site testing boils down to using HTML Proofer, a great tool that tests the generated HTML (in the public directory). I wanted to focus more on ways we can add additional tests, for example by testing Markdown files before Hugo even does its thing. So I wrote a blog post.

I wrote a blog post discussing further testing you can do with Markdown files, a tool I made called Markdown Proofer, and how we found and fixed several mistakes in the Markdown for CircleCI Docs, making a better resource for everyone.

If that sounds interesting, you can find the blog post here.


#2

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.