DEV Community

Cover image for Create modern readme in Github
Abhishek Mishra
Abhishek Mishra

Posted on • Edited on

Create modern readme in Github

To create a modern GitHub profile README, you can follow these steps:

  1. Sign in to your GitHub account and navigate to your profile page.

  2. Click the "Edit" button on your profile page.

  3. In the "Repositories" section of your profile, click the "Add" button next to "Repositories you contribute to."

  4. In the "Name" field, enter username.github.io, replacing username with your GitHub username.

  5. In the "Description" field, you can enter a brief description of your profile.

  6. Under "Add a license," select the "MIT License" option.

  7. Click the "Create repository" button.

  8. Your new repository will be created and you can use it to create your modern GitHub profile README.


To do this:

  1. In the repository, create a new file called README.md.

  2. Use Markdown syntax to add content to your README file. You can include text, links, images, and more.

  3. Preview your README file to see how it will look on your profile page.

  4. When you're satisfied with your README file, commit your changes and push them to the repository.

Your modern GitHub profile README will now be displayed on your profile page. You can customize the appearance and content of your profile by adding and modifying files in your repository. For example, you can include a link to your website, a list of your projects, or your social media profiles.


Two of my favorite github Readme generator:👇🏼

ProfileMe.dev
Just click create profile and start customizing your readme right away

ProfileMe.dev-Image

GPRM
Just put your github username and click right arrow and start customizing your readme

gprm-img


Thanks for Reading🙏

I hope this helps! Let me know if you have any other questions related to it.

Top comments (0)