Your Web News in One Place

Help Webnuz

Referal links:

Sign up for GreenGeeks web hosting
April 8, 2023 01:52 am GMT

How to Create a GitHub Profile Readme with GitHub Actions, Profile Trophy, and Custom Icons Badges

Hello everyone, in this article I gonna show you how to create a Github Profile so easily.

slydragonn github profile readme

Requirements

  • A GitHub account
  • A Youtube channel with Videos, if you want, to use the Youtube Video Cards.

Features

Project Structure

 ~/slydragonn/  .github/    workflows/           youtube-cards.yaml README.md

GitHub Repository

Tutorial video

Creating the README file

First, we should create the README.md file, thats where we put all code. You can create the file directly on the GitHub site or create it on your pc and push it to the repository.

You can start your readme as you want, I like to start with Hello world!.

# Hello World! 

As you can see, this file works with Markdown so we should use its syntax:

# h1## h2### h3**bold text***italicized text** unordered list1. ordered list[link](https://www.your-url.com)![image - alt text](url.jpg)- [x] Task List- [ ] Second Task| Table | Description || ------ | ----------- || Header | Title || Paragraph | Text |> blockquote

Custom Icon Badges

The Github Repo: https://github.com/DenverCoder1/custom-icon-badges

https://custom-icon-badges.demolab.com/badge/custom-badge-blue.svg?logo=paintbrush&logoColor=white

This is how I use it:

<p>  <a href="https://slydragonn.site">    <img alt="slydragonn portfolio" title="My Portfolio" src="https://custom-icon-badges.demolab.com/badge/my--website-white.svg?logo=sly-portfolio"/>  </a>  <a href="https://www.linkedin.com/in/alejolg/">    <img alt="linkedin" title="Linkedin" src="https://custom-icon-badges.demolab.com/badge/alejolg-blue.svg?logo=linkedin"/>  </a>  <a href="https://www.youtube.com/@slydragonn">    <img alt="youtube channel" title="Youtube" src="https://custom-icon-badges.demolab.com/badge/@slydragonn-red.svg?logo=slyyoutube&logoColor=white"/>  </a>  <a href="https://dev.to/slydragonn">    <img alt="dev community" title="DEV" src="https://custom-icon-badges.demolab.com/badge/slydragonn-black.svg?logo=devdotto"/>  </a></p>

And this is the result:

slydragonn github

About Me section

In this part you can do what you want, I did this with the code block, my info as a Javascript object, like this:

slydragonn info

GitHub Profile Trophy

The GitHub Repo: https://github.com/ryo-ma/github-profile-trophy

  • How to use: Add the following code to your readme. When pasting the code into your profile's readme, change the?username= value to your GitHub's username.
[![trophy](https://github-profile-trophy.vercel.app/?username=ryo-ma)](https://github.com/ryo-ma/github-profile-trophy)

This is how I use it:

[![trophy](https://github-profile-trophy.vercel.app/?username=slydragonn&theme=juicyfresh&title=Repositories,Stars,Commits,Followers,PullRequest,MultipleLang&margin-w=20)](https://github.com/ryo-ma/github-profile-trophy)

And the final result:

slydragonn github

Youtube Cards

You can see all steps on his GitHub Repo

But this is all code you need:

README.md<!-- BEGIN YOUTUBE-CARDS --><!-- END YOUTUBE-CARDS -->
# ~/.github/workflows/youtube-card.yamlname: GitHub Readme YouTube Cardson:  schedule:    # Runs every hour, on the hour    - cron: "0 * * * *"  workflow_dispatch:jobs:  deploy:    runs-on: ubuntu-latest    steps:      - uses: DenverCoder1/github-readme-youtube-cards@main        with:          channel_id: YOUR_YOUTUBE_CHANNEL_ID

And this is the result:

slydragonn videos

Adding a Profile README

You should create a repository with the name of your username, this is for GitHub know that is a special repo. For example, my username is slydragonn so I should create a repository called slydragonn and then push all files that we created.

Run workflow

When you push the files, only miss running the workflow for that youtube card works. You should only click the button run workflow on the Actions page, like this:

slydragonn github

And thats all, thanks for reading and see you later


Original Link: https://dev.to/slydragonn/how-to-create-a-github-profile-readme-with-github-actions-profile-trophy-and-custom-icons-badges-5h6j

Share this article:    Share on Facebook
View Full Article

Dev To

An online community for sharing and discovering great ideas, having debates, and making friends

More About this Source Visit Dev To