Skip to content

Latest commit

 

History

History
74 lines (60 loc) · 2.51 KB

README.md

File metadata and controls

74 lines (60 loc) · 2.51 KB
Raw

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.

Useage

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

Github Action:

  1. To use Github GraphQL token with getting account infomation is in need, follow the wiki to know about HOW TO MAKE A TOKEN FOR YOUR PORFILE.

  2. Add token to your profile repo secret and named it as MY_GITHUB_TOKEN, see ADD SECRET TO REPO.

  3. Insert steps below in your .yml file.

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

Run commands with args, or make a .vscode launch.json as a develop tool.

$npm run prod [arg1] [arg2] [arg3]
  • [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.