Skip to content

README.md

Latest commit

 

History

History
76 lines (63 loc) · 2.79 KB

README.md

File metadata and controls

76 lines (63 loc) · 2.79 KB

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

  • Repositories Composition
  • Tags Preference
  • ...
  • ...
  • .etc

How it works ?

Fetch data from Github GraphQL → Generate .SVG files→ Bot will commit and push on "master" branch.

Usage

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

Github Action:

  1. 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.

  2. Add the token to your profile repo secret and name it MY_GITHUB_TOKEN, see Encrypted secrets for repositories.

  3. Add the following steps to a job in your workflow (for example, in .github/workflows/profile-cards.yml):

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 }}

Local Launch:

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

npm install
npx ncc build src/index.js -o dist
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

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.