Github Format Readme

Hi folks 👋, Hope you are doing well.

Best Github Readme
Github Readme Markdown Image
Github Readme Markdown Image Size
Github Format Readme
Github Readme Markdown Cheat Sheet

Do you know about the latest feature that Github released few months back, that let’s you show Beautiful and Dynamic profile with just a simple README.md file. If not, then you should totally check this out, it’s Super Cooool 🔥.

With the changes that were applied to SageTV (Not yet in a release build), and the format detector plugin that I wrote, forced subtitles properly marked will auto select. Q: What is the reason for the media format plugin. A: The external format detector in SageTV is built on a pretty old version of FFmpeg.

In this blog, we are going to create a profile readme that will look something like this in the end,

I’ll assume you wanted to create a readme through just your terminal and you’re on a linux system. First off you should change your directory to the project directory. This can be done with the command CD example:code cd /mydirectory//code. Code hosting services such as GitHub, Bitbucket, and GitLab will also look for your README and display it along with the list of files and directories in your project. How should I make it? While READMEs can be written in any text file format, the most common one that is used nowadays is Markdown. GitHub Flavored Markdown. GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com. Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. Github gives you multiple choices where it takes it sources from. By default its the root of the master branch, which will use the README.md in case there is no index.html. But you can also switch to the docs/ folder in your repository settings.

Interesting right, let’s get started then.

Prerequisite

None 😉

Steps

1. Create a repository with same name as your github username. Check add README file option. I am getting error because I already have the repository, you will not see below error.

2. You can either clone this repo and change it locally or you can edit it in github itself. I’ll be editing it in Github just to reduce unnecessary steps.

3. Click on edit button for README.md file and paste below content for starters,

4. Feel free to add/edit/remove the Headings and change content in place ❔❔❔❔.

5. Now let’s go over it one by one. In first section, we just have simple greeting and a fancy looking badge to showcase your website. To understand how I created this badge, checkout this page.

6. In second section, we are talking about myself in some nice bullet points. Again very easy, Create your own or just replace ❔❔❔❔ with your data.

7. Soon after that, at the end of that second section we have a nice Github stats card. This is a coming from a great guy Anurag Hazra’s very popular project github-readme-stats. Checkout this repository there your will find out how to create such beautiful cards which shows your Github Stats.

8. To be specific, I am using this in for my stats, feel free to try more. Mine looks like this.

9. In next section, we are showing bunch of icons that point to our social media profiles. Pretty damn easy just have a look at readme file.

10. Next section is kinda optional, feel free to skip it if you don’t write blogs. This is pretty interesting as we are going to dynamically fetch blog data from our blogging site and populate section of README.md using Github Action.

11. This is coming from yet another great guy Gautam krishna R’s project blog-post-workflow. He has created an Github action that does this magic ⭐. Let’s see how it’s done.

12. Start by adding adding place holder like we have in our README.md file.

13. In your repository create a new workflow, by going into Actions Tab your repository. Save and commit README.md before if necessary. After creating workflow your actions tab should look like this,

Best Github Readme

14. Rename this workflow and paste below content. For more info checkout this section,

15. Change the feed_list value to your feed and start the workflow manually from Actions tab shown in above image. You don’t need change a single apart from that. For more options visit this section.

16. Last section simply contains the variables that are being used all over the places.

17. Now commit the changes and go to your profile.

Voila!! we have just created a beautiful profile readme 😉🥳🥳🥳.

If you need some reference for this README.md file checkout my repo. You can also checkout some quite awesome README files here for more inspiration 😉.

Hope you liked this blog, feel free to share it if you do.

For more such content click here.

Take care, and keep learning 😎✌

Github Readme Markdown Image

Article version: GitHub.com

You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.

If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page. You can edit your profile README with GitHub Flavored Markdown to create a personalized section on your profile. For more information, see 'Managing your profile README.'

Section links in README files and blob pages

Github Readme Markdown Image Size

Many projects use a table of contents at the start of a README to direct users to different sections of the file. You can link directly to a section in a rendered file by hovering over the section heading to expose the link:

Relative links and image paths in README files

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

GitHub will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. You can use all relative link operands, such as ./ and ../.

Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.