Resolving Staticman comment errors for Jekyll website

Note: Staticman is quite cumbersome, and has the downside of leaving rejected comments in your history, some of which may be quite offensive. There is a way to use Kismet with Staticman…but why not just use Disqus, that many people already have an account for.

Disqus anti-spam, anti-troll measure are fantastic. You’ll waste way too much time with Staticman vs. Disqus.


The Staticman comment service for statically generated websites such as Jekyll keeps your comments within your website as YML files.

  • Staticman requires your viewers to have JavaScript enabled in their web browser
  • Spam/malicious comments linger in your repository, despite not being shown on the website–this is what made me stop using Staticman
  • Staticman is extremely picky about the _config.yml file–an error in an unrelated section of _config.yml that doesn’t bother Jekyll will cause Staticman to silently fail.

_config.yml

  • be sure you don’t have more than one include: statement
  • be sure you have at least something in your staticman: requiredFields:. Leaving this blank will cause Staticman to silently fail! Put ['messages'] as a minimal requirement, assuming your staticman: allowedFields includes 'message'
  • use the Developer Console (in Chrome, Ctrl Shift i) to see the error messages when you submit your test comment

auto-delete comment branch on accept/reject (optional but highly convenient)

configure webhook for https://api.staticman.net/v1/webhook upon Pull Request.

Github webhook configuration page
configure Github webhook for Staticman.

Tags:

Categories:

Updated:

Leave a Comment