diff --git a/readme.md b/readme.md index eafbf9b2..c78a8b9b 100644 --- a/readme.md +++ b/readme.md @@ -55,12 +55,15 @@ - [Customization](#customization) - [GitHub Extra Pins](#github-extra-pins) - [Usage](#usage) + - [Options](#options) - [Demo](#demo) - [GitHub Gist Pins](#github-gist-pins) - [Usage](#usage-1) + - [Options](#options-1) - [Demo](#demo-1) - [Top Languages Card](#top-languages-card) - [Usage](#usage-2) + - [Options](#options-2) - [Language stats algorithm](#language-stats-algorithm) - [Exclude individual repositories](#exclude-individual-repositories) - [Hide individual languages](#hide-individual-languages) @@ -72,6 +75,7 @@ - [Hide Progress Bars](#hide-progress-bars) - [Demo](#demo-2) - [WakaTime Stats Card](#wakatime-stats-card) + - [Options](#options-3) - [Demo](#demo-3) - [All Demos](#all-demos) - [Quick Tip (Align The Cards)](#quick-tip-align-the-cards) @@ -365,55 +369,6 @@ If we don't support your language, please consider contributing! You can find mo > [!NOTE]\ > When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding. -#### Repo Card Exclusive Options - -| Name | Description | Type | Default value | -| --- | --- | --- | --- | -| `show_owner` | Shows the repo's owner name. | boolean | `false` | -| `description_lines_count` | Manually set the number of lines for the description. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description. | number | `null` | - -#### Gist Card Exclusive Options - -| Name | Description | Type | Default value | -| --- | --- | --- | --- | -| `show_owner` | Shows the gist's owner name. | boolean | `false` | - -#### Language Card Exclusive Options - -| Name | Description | Type | Default value | -| --- | --- | --- | --- | -| `hide` | Hides the [specified languages](#hide-individual-languages) from card. | string (comma-separated values) | `null` | -| `hide_title` | Hides the title of your card. | boolean | `false` | -| `layout` | Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. | enum | `normal` | -| `card_width` | Sets the card's width manually. | number | `300` | -| `langs_count` | Shows more languages on the card, between 1-20. | integer | `5` for `normal` and `donut`, `6` for other layouts | -| `exclude_repo` | Excludes specified repositories. | string (comma-separated values) | `null` | -| `custom_title` | Sets a custom title for the card. | string | `Most Used Languages` | -| `disable_animations` | Disables all animations in the card. | boolean | `false` | -| `hide_progress` | Uses the compact layout option, hides percentages, and removes the bars. | boolean | `false` | -| `size_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `1` | -| `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` | - -> [!WARNING]\ -> 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 - -| Name | Description | Type | Default value | -| --- | --- | --- | --- | -| `hide` | Hides the languages specified from the card. | string (comma-separated values) | `null` | -| `hide_title` | Hides the title of your card. | boolean | `false` | -| `line_height` | Sets the line height between text. | integer | `25` | -| `hide_progress` | Hides the progress bar and percentage. | boolean | `false` | -| `custom_title` | Sets a custom title for the card. | string | `WakaTime Stats` | -| `layout` | Switches between two available layouts `default` & `compact`. | enum | `default` | -| `langs_count` | Limits the number of languages on the card, defaults to all reported languages. | integer | `null` | -| `api_domain` | Sets 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 | `wakatime.com` | -| `display_format` | Sets the WakaTime stats display format. Choose `time` to display time-based stats or `percent` to show percentages. | enum | `time` | -| `disable_animations` | Disables all animations in the card. | boolean | `false` | - *** # GitHub Extra Pins @@ -432,11 +387,20 @@ Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats` [![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats) ``` +### Options + +You can customize the appearance and behavior of the pinned repository card using the [common options](#common-options) and exclusive options listed in the table below. + +| Name | Description | Type | Default value | +| --- | --- | --- | --- | +| `show_owner` | Shows the repo's owner name. | boolean | `false` | +| `description_lines_count` | Manually set the number of lines for the description. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description. | number | `null` | + ### Demo ![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra\&repo=github-readme-stats) -Use [show\_owner](#repo-card-exclusive-options) query option to include the repo's owner username +Use `show_owner` query option to include the repo's owner username ![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra\&repo=github-readme-stats\&show_owner=true) @@ -454,11 +418,19 @@ Endpoint: `api/gist?id=bbfce31e0217a3689c8d961a356cb10d` [![Gist Card](https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d)](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/) ``` +### Options + +You can customize the appearance and behavior of the gist card using the [common options](#common-options) and exclusive options listed in the table below. + +| Name | Description | Type | Default value | +| --- | --- | --- | --- | +| `show_owner` | Shows the gist's owner name. | boolean | `false` | + ### Demo ![Gist Card](https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d) -Use [show\_owner](#gist-card-exclusive-options) query option to include the gist's owner username +Use `show_owner` query option to include the gist's owner username ![Gist Card](https://github-readme-stats.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d\&show_owner=true) @@ -488,6 +460,29 @@ Endpoint: `api/top-langs?username=anuraghazra` [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats) ``` +### Options + +You can customize the appearance and behavior of the top languages card using the [common options](#common-options) and exclusive options listed in the table below. + +| Name | Description | Type | Default value | +| --- | --- | --- | --- | +| `hide` | Hides the [specified languages](#hide-individual-languages) from card. | string (comma-separated values) | `null` | +| `hide_title` | Hides the title of your card. | boolean | `false` | +| `layout` | Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. | enum | `normal` | +| `card_width` | Sets the card's width manually. | number | `300` | +| `langs_count` | Shows more languages on the card, between 1-20. | integer | `5` for `normal` and `donut`, `6` for other layouts | +| `exclude_repo` | Excludes specified repositories. | string (comma-separated values) | `null` | +| `custom_title` | Sets a custom title for the card. | string | `Most Used Languages` | +| `disable_animations` | Disables all animations in the card. | boolean | `false` | +| `hide_progress` | Uses the compact layout option, hides percentages, and removes the bars. | boolean | `false` | +| `size_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `1` | +| `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` | + +> [!WARNING]\ +> 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. + ### Language stats algorithm We use the following algorithm to calculate the languages percentages on the language card: @@ -605,6 +600,23 @@ Change the `?username=` value to your [WakaTime](https://wakatime.com) username. [![Harlok's WakaTime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)](https://github.com/anuraghazra/github-readme-stats) ``` +### Options + +You can customize the appearance and behavior of the WakaTime stats card using the [common options](#common-options) and exclusive options listed in the table below. + +| Name | Description | Type | Default value | +| --- | --- | --- | --- | +| `hide` | Hides the languages specified from the card. | string (comma-separated values) | `null` | +| `hide_title` | Hides the title of your card. | boolean | `false` | +| `line_height` | Sets the line height between text. | integer | `25` | +| `hide_progress` | Hides the progress bar and percentage. | boolean | `false` | +| `custom_title` | Sets a custom title for the card. | string | `WakaTime Stats` | +| `layout` | Switches between two available layouts `default` & `compact`. | enum | `default` | +| `langs_count` | Limits the number of languages on the card, defaults to all reported languages. | integer | `null` | +| `api_domain` | Sets 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 | `wakatime.com` | +| `display_format` | Sets the WakaTime stats display format. Choose `time` to display time-based stats or `percent` to show percentages. | enum | `time` | +| `disable_animations` | Disables all animations in the card. | boolean | `false` | + ### Demo ![Harlok's WakaTime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)