> ## Documentation Index
> Fetch the complete documentation index at: https://icons.mzrdev.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Streaks

> Track and display your GitHub contribution streaks.

## Overview

GitHub Streaks provides a high-performance SVG card that displays your total contributions, current streak, and longest streak.

## Visual Examples

### Theme Showcase

Select a theme to see how it matches your profile style.

<Tabs>
  <Tab title="Dark Theme">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&theme=dark)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&theme=dark" alt="Dark Theme" />
    </Frame>
  </Tab>

  <Tab title="Ocean Theme">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&theme=ocean)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&theme=ocean" alt="Ocean Theme" />
    </Frame>
  </Tab>

  <Tab title="Forest Theme">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&theme=forest)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&theme=forest" alt="Forest Theme" />
    </Frame>
  </Tab>

  <Tab title="High Contrast">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&theme=high-contrast)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&theme=high-contrast" alt="High Contrast Theme" />
    </Frame>
  </Tab>
</Tabs>

### Accent Color Customization

Change the primary accent color using the `color` parameter.

<Tabs>
  <Tab title="Pink Accent">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&color=ec4899)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&color=ec4899" alt="Pink Accent" />
    </Frame>
  </Tab>

  <Tab title="Orange Accent">
    ```markdown theme={null}
    ![](https://icon.mzrdev.com/stats?username=MZRCode&color=f97316)
    ```

    <Frame>
      <img src="https://icon.mzrdev.com/stats?username=MZRCode&color=f97316" alt="Orange Accent" />
    </Frame>
  </Tab>
</Tabs>

## Customization Options

### Card Settings

| Parameter       | Description                                         | Default |
| :-------------- | :-------------------------------------------------- | :------ |
| `theme`         | `dark`, `light`, `ocean`, `forest`, `high-contrast` | `dark`  |
| `card_width`    | Width of the card in pixels                         | `495`   |
| `card_height`   | Height of the card in pixels                        | `195`   |
| `border_radius` | Border radius of the card                           | `4.5`   |
| `hide_border`   | Hide the card border                                | `false` |
| `no_bg`         | Make the card background transparent                | `false` |
| `locale`        | Locale for labels (e.g., `en`, `tr`)                | `en`    |

### Color Customization

| Parameter    | Description                                                          |
| :----------- | :------------------------------------------------------------------- |
| `color`      | **Global Accent Color.** Sets ring, fire, and divider color at once. |
| `background` | Custom background color (hex)                                        |
| `border`     | Custom border color (hex)                                            |
| `fire`       | Custom fire icon color (hex)                                         |
| `ring`       | Custom ring color (hex)                                              |
| `stroke`     | Custom divider line color (hex)                                      |
| `sideNums`   | Color for side metrics numbers (hex)                                 |

## Advanced Settings

| Parameter       | Description                                     |
| :-------------- | :---------------------------------------------- |
| `streak_mode`   | Mode for streak calculation                     |
| `exclude_days`  | Days to exclude (e.g., `Sat,Sun`)               |
| `short_numbers` | Use compact number format (e.g., 1.2k)          |
| `date_format`   | Date display format (`default`, `short`, `iso`) |