You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[Astronomy Picture of the Day](/docs/widgets#astronomy-picture-of-the-day)|`https://apod.as93.net`|[NASA's Privacy Policy](https://www.nasa.gov/privacy/) (via a proxy run by Dashy's author) |
231
231
|[GitHub Trending](/docs/widgets#github-trending)|`https://trend.doforce.xyz`| No Policy Available |
Copy file name to clipboardExpand all lines: docs/widgets.md
+25-12Lines changed: 25 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1188,38 +1188,51 @@ Displays currently trending projects on GitHub. Optionally specify a language an
1188
1188
1189
1189
### GitHub Profile Stats
1190
1190
1191
-
Display stats from your GitHub profile, using embedded cards from [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
1191
+
Shows GitHub user stats (if `username`) and repos stats (for each repo in `repos`). Fetched from the GitHub API.
**`username`** | `string` | Required | The GitHub username to fetch info for. E.g. `lissy93`. (Not required if `hideProfileCard` and `hideLanguagesCard` are both set to `true`)
1200
-
**`hideProfileCard`** | `boolean` | _Optional_ | If set to `true`, the users profile card will not be shown. Defaults to `false`
1201
-
**`hideLanguagesCard`** | `boolean` | _Optional_ | If set to `true`, the users top languages card will not be shown. Defaults to `false`
1202
-
**`repos`** | `array` | _Optional_ | If you'd like to also display stats for some GitHub repositories, then add an array or repo names here. Specified as `[username]/[repo-name]`, e.g. `lissy93/dashy`
1199
+
**`username`** | `string` | _Optional_ | A GitHub username, e.g. `lissy93`. If this is set, a profile card is shown, if it's unset the card isn't shown
1200
+
**`repos`** | `array` | _Optional_ | A list of repositories to show stats for, each specified as `[owner]/[repo]`, e.g. `lissy93/dashy`
1201
+
**`token`** | `string` | _Optional_ | An optional [GitHub token](https://github.com/settings/tokens). Used to raise the API rate limit from 60 to 5,000 requests per hour (can be set directly, or as an environment variable)
1203
1202
1204
1203
#### Example
1205
1204
1206
1205
```yaml
1207
1206
- type: github-profile-stats
1208
1207
options:
1209
-
username: Lissy93
1210
-
hideLanguagesCard: true
1208
+
username: lissy93
1209
+
repos:
1210
+
- lissy93/dashy
1211
+
- lissy93/portainer-templates
1212
+
- lissy93/web-check
1213
+
```
1214
+
1215
+
Or just show the user's profile card:
1216
+
```yaml
1217
+
- type: github-profile-stats
1218
+
options:
1219
+
username: octocat
1220
+
```
1221
+
1222
+
Or just show repo(s)
1223
+
```yaml
1224
+
- type: github-profile-stats
1225
+
options:
1211
1226
repos:
1212
1227
- lissy93/dashy
1213
-
- lissy93/personal-security-checklist
1214
-
- lissy93/twitter-sentiment-visualisation
1215
1228
```
1216
1229
1217
1230
#### Info
1218
1231
1219
1232
- **CORS**: 🟢 Enabled
1220
-
- **Auth**: 🟢 Not Required
1233
+
- **Auth**: 🟡 Optional (a `token` raises the rate limit)
1221
1234
- **Price**: 🟢 Free
1222
-
- **Host**: Managed Instance or Self-Hosted (see [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats))
0 commit comments