Step 1: Create Your Profile Repository
If you haven't done this yet, you need to create a special repository first:
- Create a new repository on GitHub.
- The repository name must exactly match your GitHub username (case-sensitive).
- Check the "Add a README file" option.
- Once created, the
README.mdin this repository will be displayed at the top of your personal GitHub profile.
Step 2: Choose and Copy a Template
Template Repository: Awesome-Profile-README-templates
The templates in this repository are categorized into several folders based on style. You can explore them to find your favorite:
* short-and-sweet: Minimalist style.
* code-styled: Geek style, looks like a code editor.
* dynamic-realtime: Dynamic and real-time updates (usually requires GitHub Actions).
* elaborate: Detailed content, including various charts and an extensive intro.
* multimedia: Contains multimedia elements (like GIFs).
How to Apply:
1. Browse Folders: Click into any of the folders listed above.
2. Open a File: You will see many .md files named after users (e.g., saviomartin.md). Click on a file you find visually appealing.
3. Copy the Code:
* Case A (Code available directly): If the file contains extensive Markdown code (like badge links and intro text), simply click the Copy raw file button in the top right corner to copy everything.
* Case B (Only images/links available): Some files might only display a preview image and a link (e.g., "From xxxx"). In this case, click the link to go to the original author's profile, find their namesake repository (username/username), and copy the code from their README.md.
Step 3: Modify and Personalize
Paste the copied code into your own repository's README.md. This is the most crucial step, as saving it directly will display someone else's information. You need to perform a global replacement:
- Replace the Username: Use your text editor's "Find and Replace" function to replace the template's original author username (e.g.,
saviomartin) with your own GitHub username. This will automatically fix your stat cards, badges, and links. - Modify Personal Info:
* Update your introduction ("Hi, I'm...").
* Update your social media links (Twitter, LinkedIn, etc.).
* Modify the skill icons (delete the ones you don't know, and add the ones you do). - Save and Commit: Click "Commit changes" to save your finalized profile.