GitHub READMEs work exceptionally well for projects which only need a single page of docs.
Transitioning to a hosted, multiple page documentation structure is hard though. I've dabbled with a few tools but not found a clear favourite yet.
miniblog.
Related Posts
I'm hesitant to write "written in $LANG" on my project READMEs. I'd rather get users excited about the features than the implementation.
Maybe it makes sense if you're primarily seeking contributors?
Badges to Acknowledge Open Practices: A Simple, Low-Cost, Effective Method for Increasing Transparency https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1002456
'Open Data' badges on scientific papers hugely increased the amount of open data. Reminds me of READMEs with testing badges!
Here's a neat GitHub feature that I haven't noticed before: if you hover over Contributors, it shows you profile pictures of major contributors!
This picture is from https://github.com/github/semantic.
Reminds me of JS projects that generate READMEs with this visualisation.
