How to Upload File in Github Comment

3 Ways to Add an Image to GitHub README

Images oft come in handy alongside documentation. Here are a few methods for calculation them to your README and other markdown files.

Images can be a great style to heighten your documentation in README files or other markdown documentation. While there is a standard fashion 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.

Markdown Syntax

The original documentation specifies that images should exist written like so:

                                    ![Alt text](/posts/path/to/img.jpg              "Optional championship")                  

HTML code is also valid inside virtually markdown renderers, including GitHub's flavor. That ways you lot could also render an the image to a higher place like this:

                                                    <img              src                              =                "/path/to/img.jpg"                            alt                              =                "Alt text"                            title                              =                "Optional title"                            >                              

This is a bang-up option if you want to add a little custom styling to your epitome. For case, if you desire to control the size or alignment of the image, you might do something like this:

                                                    <img              
              src                              =                "/path/to/img.jpg"                            
              alt                              =                "Alt text"                            
              championship                              =                "Optional title"                            
                              style                                  =                  "                                      display                    :                    inline-cake;                    margin                    :                    0 auto;                    max-width                    :                    300px                  "                                            >                              

Method #1: Local File

The first method is to commit the image direct to your GitHub repository. When y'all exercise that, y'all can utilize a path to that file for the src, which should be relative from the markdown file.

In other words, if you place an epitome file in the root your project as my-image.jpg, you lot could then render the image in your projects primary README.md file like this (championship omitted for simplicity):

README.md

                                    ![My Image](my-epitome.jpg)                  

Permit'south say the image file was instead in an images directory. Then your lawmaking in the project'due south main README file would expect like this:

README.md

                                    ![My Image](images/my-prototype.jpg)                  

Now, let's say that you lot have another README file in your src directory, but your image is still in the images directory. And then your relative path looks like this:

src/README.doctor

                                    ![My Image](../images/my-prototype.jpg)                  

This arroyo is a quick and easy option, as long as y'all don't accept too many images to manage. If you end up using a lot of images, I'd consider another route ...

Method #2: Remote File

Another pick is to utilize some external file hosting service to provide your image, such as S3 or Dropbox. In this case, you could get the direct and full URL to the image and so utilise that.

README.md

                                    ![My Remote Image](https://www.dropbox.com/s/.../my-remote-prototype.jpg?dl=0)                  

Method #3: Uploaded File

Lastly, you could use GitHub to host the image for you lot. This one is a little goofy, but it totally works!

The trick is to add them to some comment — an effect, pull request or discussion — and then grab the resulting URL.

You can drag and drop the prototype from your computer to a annotate field in GitHub. Wait for the file to upload and then the URL to the image is right there! You don't fifty-fifty have to submit the issue if you don't desire to (although that may limit the paradigm's lifespan).

Unlike the other two options, I meet two issues with this approach:

1. On its ain, it becomes hard to know the source of the image. Perchance that's non a big bargain, or maybe yous have a manner to streamline it — e.g. all your images go into a single "Images" issue that stays open up.
2. The purpose of images in comments is technically to serve the comment. It'southward possible GitHub changes these URLs without notifying yous.

Inspiration & Resources

This post was originally inspired by this tweet from @DavidDarnes:

Haha prissy! FYI if you lot upload those readme images in a new GitHub comment and information technology'll give you the image paths back to put them in your readme, so you won't have them cluttering the repo 😶

— Dave 🧱 (@DavidDarnes) January 18, 2021

I ended upwardly being more comprehensive than just this singular suggestion, which came to be more than in-line with this StackOverflow question.

schwartzboakist86.blogspot.com

Source: https://www.seancdavis.com/posts/three-ways-to-add-image-to-github-readme/

Share this post