DEV Community

Discussion on: Where do you store GitHub README.md assets?

View post
Collapse
 
michaelcurrin profile image
Michael Currin • • Edited

If it is just a few things like a handful of screenshots, it goes in the top level.

README.md
sample-1.png
sample-2.png
Enter fullscreen mode Exit fullscreen mode

Other times I'll use docs/_media.

docs/
  _media
    sample-1.png
    sample-2.png
  README.md
README.md
Enter fullscreen mode Exit fullscreen mode

I saw .media before but it ends up getting hidden in folder navigator, so I prefer _media.
I might have used _images before.

If the docs folder is actually a docs site like Docsify or Jekyll, I'll use assets instead of _media. And maybe separate out assets/img/ and assets/css to follow HTML conventions.