Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Have you got an idea how to embed screenshots in README???


You can just use normal markdown format.

For example, if you have your screenshots in a directory in the repo called `docs/images` you can include it with:

![alt text goes here](docs/images/example.png)


Thanks! In the next 24 hours I will add screenshots :-)


I would look at one of the many other projects that have them in their readme and see how they do it, I think it's with a certain markdown syntax but I don't know it off the top of my head. Hope this helps.




Consider applying for YC's Summer 2026 batch! Applications are open till May 4

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: