Home

🫧 GitHub Bubble Chart Wiki

Welcome to the official documentation for the GitHub Bubble Chart! This wiki provides detailed information on how to use, configure, and customize the project to suit your needs.

Overview

The GitHub Bubble Chart is a tool that visualizes a set of data through an interactive bubble chart. It supports multiple customization options and can be easily embedded in your GitHub profile or other web pages.

🌟 Key Features

• Top Languages: Fetches and visualizes the most used languages from your GitHub repositories.
• Custom Config Mode: Define your own data and settings using a JSON configuration file.
• Dynamic Appearance: Modify chart appearance and behavior through URL parameters or custom settings.
• Multiple Themes: Choose from predefined themes, including dark mode.

Wiki Structure

Getting Started

• Usage – How to generate and display charts with GitHub Bubble Chart.
• Installation & Deployment – Setting up your own instance of the GitHub Bubble Chart.
• Local Development – Guide for setting up the project for local development and contributing.

Configuration

• API URL Parameters – List of supported parameters for customization.
• Custom Config Mode – Using a JSON file for advanced settings.
• Advanced Options – Advanced features including custom data sources and theming.
• Themes – Modify chart appearance.

Updates & Support

• Releases – Changelog and new features.
• FAQ & Troubleshooting – Common issues and solutions.

🚀 Get Involved

We welcome contributions! Check out the Contributing Guide and the Local Development guide for information on how to help improve this project.