https://github.com/param302/codetrack
https://github.com/param302/codetrack
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/param302/codetrack
- Owner: Param302
- Created: 2024-12-02T11:15:38.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T18:19:10.000Z (6 months ago)
- Last Synced: 2024-12-10T19:43:01.813Z (6 months ago)
- Language: TypeScript
- Homepage: https://code-track.vercel.app
- Size: 325 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CodeTrack
CodeTrack is a simple tool to visualize your GitHub contribution heatmap.
## Properties
### attributes
- `username`: Github username of the user.
- `width`: the width of the heatmap. It must be `800px` only.
#### optional
- `scale`: the scale of the heatmap. Defaults to `1`.
- `gap`: the gap between the squares in pixels. Defaults to `5`.
- `borderRadius`: the border radius of the squares in pixels. Defaults to `3`.
- `theme`: the color theme to use. Example: `github-dark`, `github-light`, `github-dimmed`. Defaults to `github-dark`.
- `showProfileData`: whether to show the profile data (Pic & Name with github icon). Defaults to `true`.
- `showTotalContributions`: whether to show the total number of contributions. Defaults to `false`.
- `showTooltip`: whether to show the tooltip. Defaults to `false`.
- `showWeekdays`: whether to show the weekdays. Defaults to `false`.
- `showMonths`: whether to show the months. Defaults to `false`.
- `shareableSnapshot`: whether to show the shareable snapshot button. Defaults to `false`.