Git Readme Format

  



In this tutorial, we are going to learn about two different ways to add images to the GitHub README.md file.

I generally write things that I'm going to publish on my README file on excel file and save it as csv and import into this tool and copy paste the Generated Markdown and it creates a table that its decent for others to read your instructions. Hope that helps.

First way

  1. Open your GitHub repository and navigate to the images folder or the folder where your images are placed.
  1. Click on the image you need to add to your README.md file.
  2. Now, right-click on the image and select copy image address option.
  • You can see that your new README file is untracked, because it’s under the “Untracked files” heading in your status output. Untracked basically means that Git sees a file you didn’t have in the previous snapshot (commit); Git won’t start including it in your commit snapshots until you explicitly tell it to do so.
  • He has created an Github action that does this magic ⭐. Let’s see how it’s done. Start by adding adding place holder like we have in our README.md file. In your repository create a new workflow, by going into Actions Tab your repository. Save and commit README.md before if necessary.
Git Readme Format
  1. At final, open your README.md file and use below markdown syntax to add an image.

In the above syntax, you need to add your copied image address inside parenthesis ().

Second way

Git Readme FormatGit readme formatting
  1. Open your GitHub repository and click on the Issues tab.
  1. Now, click on the New Issue button and drag and drop your image inside Leave a comment box.
  1. Once the image is successfully uploaded you will get a markdown image syntax, just copy and paste it inside your README.md file.

Hello, I am struggling to figure out why the only thing I see on github pages is the readme file.

I have been giving myself a crash course on all this for the last week so excuse my ignorance

I believe that I have the repo set up properly here:

What I am trying to do is add google ad sense tags to the website that the above repo builds. In order to see if any changes I make are working and to give me a sandbox I followed the instructions to publish to a github page here:

However all I see is the readme file. Is this right?

Since this is a working website I was expecting to see a copy of www.eostalk.io Am I completely missing something here?

Example Github Readme

Thank you in advance for your help!

Git Readme Format Line Break

-Dan