Github-profilemd-Generater

English | 日本語 | 繁體中文 | 简体中文

Info

Github-profilemd-Generate is a tool works on Github Action,
To generate account info on Github as a profile card or resume.

Feature

Overview stats (Stars / Repos / Followers / Commits / PR / Issue)
Repositories language composition (by real code byte size)
Topics / tags preference
Configurable themes, top-N, hidden languages and output directory

How it works ?

Fetch data from Github GraphQL → Generate .SVG files→ Bot will commit and push on the "release" (default) branch. Runs on the GitHub Actions node24 runtime.

Usage

Before use this tool, make sure you found the SPECIAL SECRET of Github.
ex. kwangsing3/kwangsing3

Github Action:

To use Github GraphQL, a personal access token with the necessary scopes is needed; follow the guide to know about HOW TO MAKE A TOKEN FOR YOUR PROFILE.
Add the token to your profile repo secret and name it MY_GITHUB_TOKEN, see Encrypted secrets for repositories.
Add the following steps to a job in your workflow (for example, in .github/workflows/profile-cards.yml):

permissions:
  contents: write          # let the bot commit cards back to the repo

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: kwangsing3/github-profilemd-Generater@release
        env:
          GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
        with:
          USERNAME: ${{ github.repository_owner }}
          GITHUB_REPO_NAME: ${{ github.event.repository.name }}
          # optional:
          THEME: 'all'        # or a comma list, e.g. "nord_dark,dracula"
          TOP_N: '8'          # number of languages / tags per card
          HIDE: ''            # languages to exclude, e.g. "HTML,CSS"
          OUTPUT_DIR: 'output'

🔒 For production, pin @release to a commit SHA and grant only the permissions the workflow needs.

Local Launch:

Install dependencies and build the bundle, then run with your inputs.

npm install
npm run build
node dist/index.js [username] [reponame] [MY_GITHUB_TOKEN]

[arg1]: username
[arg2]: reponame
[arg3]: MY_GITHUB_TOKEN

Development

git clone https://github.com/kwangsing3/github-profilemd-Generater
npm install
npm test        # unit tests (node:test)
npm run build   # bundle to dist/ (rebuild & commit before pushing)

Source is ESM and requires Node.js 24. The dist/ bundle is committed; CI verifies it stays in sync with the source.

Others

To keep your profile md looking good, Github-profilemd-Genearater will NOT rewrite your README.md, it'll provide account info as svg cards and Dynamically update to the repo (./output/github-profilemd-generater/) as default , so make sure your README.MD using relative PATH to the file instead of hosting links.

*** Also leave a star, hope this tool would give you a big help some day. ***

THANK YOU :)

Theme request. any request are welcome.

FilesExpand file tree

README.md

Latest commit

History