This repository will be discontinued because i did a complete refactor, The the new repository will be: WeebProfile
A simple and customizable way to display code, anime, and music stats on your GitHub profile README.
Here are the available sections and their respective images:
MAL
This is the default style for all sections. If you want to use a different style, you can specify it in the plugin options.
| Section | Default Image Showcase |
statistics |
|
anime_bar |
|
manga_bar |
|
statistics_simple |
|
anime_simple_favorites |
|
manga_simple_favorites |
|
people_simple_favorites |
|
character_simple_favorites |
|
anime_favorites |
|
manga_favorites |
|
people_favorites |
|
character_favorites |
|
last_activity |
This is the terminal style version of the sections. If you want to use this style you can specify it in the plugin options.style: 'terminal'
| Section | Terminal Image Showcase |
statistics |
|
anime_bar |
Image for anime_bar not found |
manga_bar |
Image for manga_bar not found |
statistics_simple |
|
anime_simple_favorites |
|
manga_simple_favorites |
|
people_simple_favorites |
|
character_simple_favorites |
|
anime_favorites |
|
manga_favorites |
|
people_favorites |
|
character_favorites |
|
last_activity |
LASTFM
This is the default style for all sections. If you want to use a different style, you can specify it in the plugin options.
| Section | Default Image Showcase |
recent_tracks |
|
statistics |
|
top_artists_grid |
|
top_artists_list |
|
top_artists_default |
|
top_albums_list |
|
top_albums_grid |
|
top_albums_default |
|
top_tracks_list |
|
top_tracks_grid |
|
top_tracks_default |
This is the terminal style version of the sections. If you want to use this style you can specify it in the plugin options.style: 'terminal'
| Section | Terminal Image Showcase |
recent_tracks |
|
statistics |
|
top_artists_grid |
|
top_artists_list |
|
top_artists_default |
|
top_albums_list |
|
top_albums_grid |
|
top_albums_default |
|
top_tracks_list |
|
top_tracks_grid |
|
top_tracks_default |
GITHUB
This is the default style for all sections. If you want to use a different style, you can specify it in the plugin options.
| Section | Default Image Showcase |
profile |
Image for profile not found |
repositories_data |
Image for repositories_data not found |
favorite_languages |
|
favorite_license |
|
repository |
Image for repository not found |
This is the terminal style version of the sections. If you want to use this style you can specify it in the plugin options.style: 'terminal'
| Section | Terminal Image Showcase |
profile |
Image for profile not found |
repositories_data |
Image for repositories_data not found |
favorite_languages |
|
favorite_license |
|
repository |
Image for repository not found |
Setting up your WeebProfile is easy and can be done in a few steps:
- Go to your GitHub profile and create a new public Gist
- Copy the Gist ID from the URL (e.g.
https://gist.github.com/username/gist_id)
- Create a new repository with your username as the repository name (e.g.
github.com/username/username) - Create a new file called
README.md - Commit the changes, now in your profile, you should see the repository like this:
💡 A GitHub personal token is required since this action will fetch data that cannot be accessed through repository-scoped tokens (like
${{ secrets.GITHUB_TOKEN }}or${{ github.token }}) such as users, pull requests, commits, activity, etc.
- Go to GitHub settings>Developer settings>Personal access tokens>personal access token(classic)
- Generate a new token (classic) with the
gistscope - Copy the token and save it in a safe place (you won't be able to see it again)
Only the gist scope is required for now as it's the only method to save the SVG without being local.
Additional scopes may be required depending on which features will be used. Each plugin documentation enumerates which scopes are required to make it work.
As a general rule, the following scopes may be required:
public_repofor some pluginsrepofor all private repositories related metrics
💡 When a plugin has not enough scopes to operate and error message will be displayed in the action console
- Go to the repository settings and click on the
Secrets and Variablestab - Go to the
Actionssectionhttps://github.com/username/username/settings/secrets/actions - Add a new secret called
GIST_IDwith the Gist ID - Add a new secret called
WEEB_GH_TOKENwith the GitHub Token
- Go to the
.github/workflowsfolder in your repository (if it doesn't exist, create it) - Create a new file called
weeb_profile.ymland paste the following code:
name: WeebProfile
on:
# 🦀 Schedule
schedule: [{ cron: "0 0 * * *" }] # Everyday at 00:00 UTC
# 💡 The following line lets you run workflow manually from the action tab!
workflow_dispatch:
# 🚀 Push event
jobs:
weeb_profile:
runs-on: ubuntu-latest
steps:
- name: 🦀 LastFM & Github 🦀
uses: LucasHenriqueDiniz/WeebProfile@main
with:
FILENAME: LastFM.svg
GIST_ID: ${{ secrets.GIST_ID }}
GH_TOKEN: ${{ secrets.WEEB_GH_TOKEN }}
STORAGE_METHOD: gist
STYLE: default
SIZE: half
PLUGIN_LASTFM: true
PLUGIN_LASTFM_HIDE_HEADER: true
PLUGIN_LASTFM_USERNAME: Amayacrab
PLUGIN_LASTFM_SECTIONS: recent_tracks, top_artists_grid, top_albums_grid
PLUGIN_GITHUB: true
PLUGIN_GITHUB_HIDE_HEADER: true
PLUGIN_GITHUB_USERNAME: LucasHenriqueDiniz
PLUGIN_GITHUB_SECTIONS: favorite_languages
- name: 🦀 MyAnimeList 🦀
uses: LucasHenriqueDiniz/WeebProfile@main
with:
FILENAME: MyAnimeList.svg
GIST_ID: ${{ secrets.GIST_ID }}
GH_TOKEN: ${{ secrets.WEEB_GH_TOKEN }}
STORAGE_METHOD: gist
SIZE: half
STYLE: default
PLUGIN_MAL: true
PLUGIN_MAL_HIDE_HEADER: true
PLUGIN_MAL_USERNAME: Amayacrab
PLUGIN_MAL_SECTIONS: statistics_simple, character_simple_favorites, anime_favorites- Commit the changes
- Go to the Actions tab in your repository, you should see the workflow running
💡 Now in the
Actionstab of your repository, you should see the workflow running and generating the SVGs.
💡 The SVGs will be saved in the Gist you created in step 1
💡 You can run it manually by clicking on the
Run workflowbutton
- Go to your GitHub profile and click on the
Edit profilebutton - In the
Aboutsection, paste the following code:
💡 Don't forget to replace
usernameandgist_idwith your GitHub username and Gist ID
💡 If you used other filename in the action replace in the link ex: LastFM.svg or MyAnimeList.svg
- Replace
usernameandgist_idwith your GitHub username and Gist ID - Save the changes
💡 Now in your profile, you should see the SVGs like this
Example:
The weeb_profile.yml file is where you can configure the plugins and the SVGs that will be generated.
Each plugin has its own configuration, and you can enable or disable them by setting the PLUGIN_NAME to true or false.
You can see the available configurations for each plugin in the Available plugins section.
| Key | Default | Description |
|---|---|---|
| FILENAME | MyProfile.svg | The name of the SVG file that will be generated |
| GIST_ID | '' | The Gist ID where the SVG will be saved |
| GH_TOKEN | '' | The GitHub Token used to save the SVG |
| SIZE | half | The size of the SVG (half or full) |
| STYLE | default | The style of the SVG (default or terminal) |
| STORAGE_METHOD | gist | The storage method of the SVG (gist, local or repository) |
| CUSTOM_CSS | '' | The custom CSS that will be applied to the SVG |
| PLUGINS_ORDER | 'github, lastfm, mal' | The order of the plugins that will be generated |
| CUSTOM_PATH | '' | The custom path where the SVG will be saved when using local storage |
| hide_terminal_emojis | false | Hide emojis in the terminal style |
💡 Every section will always have
hide_titleortitleoptions, where you can respectively hide the title or use a custom title
If you are interested in contributing, the following resources may interest you:
Use 💬 discussions for feedback, new features suggestions, bugs reports or to request help for installation.
Apache License 2.0
Copyright (c) 2024-2024