aselimov/hugo-unified-git-activity
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Finalize v1 of README.md

Browse source
This commit is contained in:
Alex Selimov 2026-05-15 20:21:36 -04:00
parent 0c7f7a6853
commit e07b96c2fa
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -79,7 +79,7 @@ color_low = "#F7C46A"
swap_colors = true # Optional, defaults to true swap_colors = true # Optional, defaults to true
``` ```
The colors swap, `color_low <--> color_max, color_mid <--> color_high` based on the user prefers setting by default. Set `swap_colors = false` to keep the same low-to-max color order in both light and dark modes. The colors swap, `color_low <--> color_max, color_mid <--> color_high` based on a `@media (prefers-color-scheme: dark/light)` query. Set `swap_colors = false` to keep the same low-to-max color order regardless.
### Keeping activity in-sync ### Keeping activity in-sync
@ -94,6 +94,9 @@ If you aren't on a VPS and using actions to deploy your site ([that's how I depl
## Important Notes ## Important Notes
- I originally wrote it in Typescript but thought go would be better to distribute to Hugo users (since you probably already have go installed) **so the go version is a completely vibed port**. I didn't look at the code, but it's probably fine? I did verify it's not sending credentials anywhere at least. - I originally wrote it in Typescript but thought go would be better to distribute to Hugo users (since you probably already have go installed) **so the go version is a completely vibed port**. I didn't look at the code, but it's probably fine?
- Private repo contributions are tracked, but they are anonymized in the activity.json. It shows up as `"private": "<count>"`. - Private repo contributions are tracked, but they are anonymized in the activity.json. It shows up as `"private": "<count>"`.
- I added Gitlab functionality but I don't use Gitlab so it may have issues. I set up a test account and did a quick test to make sure a new commit showed up, but good likelihood of edge cases. - I added Gitlab functionality but, I don't use Gitlab so it may have issues. I set up a test account and did a quick test to make sure a new commit showed up, but good likelihood of edge cases.
- The activity script will deduplicate based on repo name. Example: You have a repo named `cool-project` on with 1 Github contribution, 8 Forgejo contributions, and 1 Gitlab contribution. This code will grab the daily activity for that project across all providers and pick the highest value for the day, 8.