Images often come in handy alongside documentation. Here are a few methods for adding them to your README and other markdown files.
Images can be a great way to enhance your documentation in README files or other markdown documentation. While there is a standard way to add an image in markdown, the nuance is in the image's source. Here are three methods for adding images to markdown files in a GitHub repository.
The original documentation specifies that images should be written like so:
![Alt text](/posts/path/to/img.jpg "Optional title")
HTML code is also valid within most markdown renderers, including GitHub's flavor. That means you could also render an the image above like this:
<img src="/path/to/img.jpg" alt="Alt text" title="Optional title">
This is a great option if you want to add a little custom styling to your image. For example, if you want to control the size or alignment of the image, you might do something like this:
style="display: inline-block; margin: 0 auto; max-width: 300px">
The first method is to commit the image directly to your GitHub repository. When you do that, you can use a path to that file for the
src, which should be relative from the markdown file.
In other words, if you place an image file in the root your project as
my-image.jpg, you could then render the image in your projects main
README.md file like this (
title omitted for simplicity):
Let's say the image file was instead in an
images directory. Then your code in the project's main README file would look like this:
Now, let's say that you have another README file in your
src directory, but your image is still in the
images directory. Then your relative path looks like this:
This approach is a quick and easy option, as long as you don't have too many images to manage. If you end up using a lot of images, I'd consider another route ...
![My Remote Image](https://www.dropbox.com/s/.../my-remote-image.jpg?dl=0)
Lastly, you could use GitHub to host the image for you. This one is a little goofy, but it totally works!
The trick is to add them to some comment — an issue, pull request or discussion — and then grab the resulting URL.
You can drag and drop the image from your computer to a comment field in GitHub. Wait for the file to upload and then the URL to the image is right there! You don't even have to submit the issue if you don't want to (although that may limit the image's lifespan).
Unlike the other two options, I see two issues with this approach:
Haha nice! FYI if you upload those readme images in a new GitHub comment and it'll give you the image paths back to put them in your readme, then you won't have them cluttering the repo 😶— Dave 🧱 (@DavidDarnes) January 18, 2021
I ended up being more comprehensive than just this singular suggestion, which came to be more in-line with this StackOverflow question.