mirror of
https://github.com/System-End/github-readme-stats.git
synced 2026-04-19 18:45:21 +00:00
feat: default values for wakatime and language (#2103)
* default values for wakatime and language * docs: update formatting Co-authored-by: rickstaa <rick.staa@outlook.com>
This commit is contained in:
Aditya Shelke
GitHub
parent
c03bb2f250
commit
7accd1a8d7
1 changed files with 28 additions and 30 deletions
58
readme.md
58
readme.md
|
|
@ -6,7 +6,7 @@
|
|||
<p align="center">
|
||||
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
|
||||
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
|
||||
</a>
|
||||
</a>
|
||||
<a href="https://github.com/anuraghazra/github-readme-stats/graphs/contributors">
|
||||
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/anuraghazra/github-readme-stats" />
|
||||
</a>
|
||||
|
|
@ -64,9 +64,8 @@
|
|||
</p>
|
||||
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
|
||||
|
||||
<p>
|
||||
<a href="https://indiafightscorona.giveindia.org">
|
||||
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
|
||||
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
|
||||
</a>
|
||||
|
||||
Are you considering supporting the project by donating? Please DON'T!!
|
||||
|
|
@ -74,8 +73,7 @@ Are you considering supporting the project by donating? Please DON'T!!
|
|||
Instead, Help India fight the 2nd deadly wave of COVID-19.
|
||||
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
|
||||
|
||||
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis.
|
||||
A small donation goes a long way. :heart:
|
||||
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis. A small donation goes a long way. :heart:
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -142,13 +140,13 @@ To enable icons, you can pass `show_icons=true` in the query param, like so:
|
|||
|
||||
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
|
||||
|
||||
Use `&theme=THEME_NAME` parameter like so :-
|
||||
Use `&theme=THEME_NAME` parameter like so :
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
#### All inbuilt themes:-
|
||||
#### All inbuilt themes
|
||||
|
||||
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
||||
|
||||
|
|
@ -160,7 +158,7 @@ You can look at a preview for [all available themes](./themes/README.md) or chec
|
|||
|
||||
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params.
|
||||
|
||||
#### Common Options:
|
||||
#### Common Options
|
||||
|
||||
- `title_color` - Card's title color _(hex color)_. Default: `2f80ed`.
|
||||
- `text_color` - Body text color _(hex color)_. Default: `434d58`.
|
||||
|
|
@ -183,7 +181,7 @@ You can provide multiple comma-separated values in the bg_color option to render
|
|||
|
||||
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
|
||||
|
||||
#### Stats Card Exclusive Options:
|
||||
#### Stats Card Exclusive Options
|
||||
|
||||
- `hide` - Hides the [specified items](#hiding-individual-stats) from stats _(Comma-separated values)_. Default: `[] (blank array)`.
|
||||
- `hide_title` - _(boolean)_. Default: `false`.
|
||||
|
|
@ -201,36 +199,36 @@ You can provide multiple comma-separated values in the bg_color option to render
|
|||
> Note on `hide_rank`:
|
||||
> When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
|
||||
|
||||
#### Repo Card Exclusive Options:
|
||||
#### Repo Card Exclusive Options
|
||||
|
||||
- `show_owner` - Show the repo's owner name _(boolean)_. Defaults to `false`.
|
||||
- `show_owner` - Show the repo's owner name _(boolean)_. Default: `false`.
|
||||
|
||||
#### Language Card Exclusive Options:
|
||||
#### Language Card Exclusive Options
|
||||
|
||||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
|
||||
- `hide_title` - _(boolean)_. Defaults to `false`.
|
||||
- `layout` - Switch between two available layouts `default` & `compact`
|
||||
- `card_width` - Set the card's width manually _(number)_
|
||||
- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_
|
||||
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_
|
||||
- `custom_title` - Sets a custom title for the card
|
||||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ .Default: `[] (blank array)`.
|
||||
- `hide_title` - _(boolean)_. Default: `false`.
|
||||
- `layout` - Switch between two available layouts `default` & `compact`. Default: `default`.
|
||||
- `card_width` - Set the card's width manually _(number)_. Default `300`.
|
||||
- `langs_count` - Show more languages on the card, between 1-10 _(number)_. Default `5`.
|
||||
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_. Default: `[] (blank array)`.
|
||||
- `custom_title` - Sets a custom title for the card _(string)_. Default `Most Used Languages`.
|
||||
|
||||
> :warning: **Important:**
|
||||
> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
|
||||
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
|
||||
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
||||
|
||||
#### Wakatime Card Exclusive Options:
|
||||
#### Wakatime Card Exclusive Options
|
||||
|
||||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
|
||||
- `hide_title` - _(boolean)_. Defaults to `false`.
|
||||
- `line_height` - Sets the line-height between text _(number)_. Default Value: `25`.
|
||||
- `hide_progress` - Hides the progress bar and percentage _(boolean)_
|
||||
- `custom_title` - Sets a custom title for the card
|
||||
- `layout` - Switch between two available layouts `default` & `compact`
|
||||
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages
|
||||
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi)
|
||||
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
|
||||
- `hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`.
|
||||
- `hide_title` - _(boolean)_. Default `false`.
|
||||
- `line_height` - Sets the line-height between text _(number)_. Default `25`.
|
||||
- `hide_progress` - Hides the progress bar and percentage _(boolean)_. Default `false`.
|
||||
- `custom_title` - Sets a custom title for the card _(string)_. Default `Wakatime Stats`.
|
||||
- `layout` - Switch between two available layouts `default` & `compact`. Default `default`.
|
||||
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages _(number)_. Default `50`.
|
||||
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) _(string)_. Default `Wakapi`.
|
||||
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options. _(YYYY-MM, last_7_days, last_30_days, last_6_months, last_year, or all_time)_. Default `all_time`.
|
||||
|
||||
* * *
|
||||
|
||||
|
|
@ -441,7 +439,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
|
|||
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
|
||||
this takes time. You can use this service for free.
|
||||
|
||||
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:-
|
||||
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:
|
||||
|
||||
- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
|
||||
- Starring and sharing the project :rocket:
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue