Small extra hint for beginners about html-proofer HOT 2 OPEN

The lines you’ve quoted are for using this library in a Ruby program. The steps for using the CLI is here.

If that’s not helpful—if you can give me more information on your scenario (“I want to write a bash script using htmlproofer that does…”), I can write better docs around it!

from html-proofer.

Thanks for your quick reply! I think the guide for the CLI tool, and the --help docs are good already, that's what I've been using so far.

I was suspecting that it was Ruby, and I'm just getting into the basics of Ruby now after getting confirmation from you :) my goal is to be able to use HTMLProofer without needing bash scripts for everything. I just think it would be helpful to clearly state in the guide how you would proceed with creating and running the script. Something like

# I don't know if this would be correct
touch htmlproofer_demo.rb
# ... Write contents of the file ...
ruby htmlproofer_demo.rb

I think the barrier to entry could be lowered a bit by something like that. After all, this is a tool that can be very useful for people who know next-to-nothing about Ruby and just need to put together some basic scripts (which is a nice excuse to start learning Ruby as well).

from html-proofer.