glancecard

glancecard

Transform your GitHub profile and repositories into visually appealing SVG cards. glancecard offers daily updates for your README files, generated seamlessly by GitHub Actions without the need for external servers or dependencies.

Key Features

• Repository Card: Generate a comprehensive overview of any public repository, including status, age, latest tag, description, and topics. The card showcases commits from the last 30 days with a sparkline, detailed commit activity over the year, languages used, and contributor information.

• Profile Card: Create an engaging profile card that displays follower counts, stars, repositories, pull requests, issues, and a year of contributions through dynamic charts. Observe the star history across all public repositories since inception, highlighting the most popular projects alongside their respective languages.

• Versatile Themes: Choose from a variety of nine unique designs, including Midnight, Aurora, Daylight, Upside Down, Hyperspace, Bridge, Nebula, Halloween, and Christmas. The cards automatically adjust to match GitHub's dark or light themes, enhancing the viewer's experience.

• Automated Generation: Each card is refreshed daily through your own GitHub Actions workflow. This automation ensures that cards remain updated without manual intervention, as they are stored as files directly in your repository.

Quick Setup

To set up glancecard with minimal effort, simply paste the provided configuration into any coding assistant that supports shell commands. This will handle the necessary steps to integrate glancecard into your repository, ensuring it runs smoothly on a daily schedule.

Set up glancecard for me (https://github.com/gfazioli/glancecard): it renders SVG cards of my GitHub profile and repositories once a day.

Displaying Cards

Cards can be easily embedded into your README with a straightforward HTML structure. This allows you to showcase both your profile and repository activity elegantly:

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="glancecard/repo-dark.svg">
  <img src="glancecard/repo-light.svg" width="880" alt="Your Repository at a glance">
</picture><br>
<sub>Made with <a href="https://github.com/gfazioli/glancecard">glancecard</a> · refreshed daily</sub>

Design Options

Each card design provides thematic looks that suit various aesthetics, catering to both dark and light modes. Special seasonal looks such as halloween and christmas are also available, renewing automatically during their respective times of the year.

Maintainability and Updates

Designed to be self-sustaining, glancecard integrates with Dependabot to automatically update the action used for card generation, ensuring the latest features and improvements are always in use.

Preliminary Preview

For users who prefer command-line tools, glancecard can be generated directly from the terminal using the command:

npx github:gfazioli/glancecard repo your-login/your-repo --out cards

Community Support

Contributions and sponsorships are highly appreciated to maintain and enhance glancecard. Supporting the project ensures ongoing updates, feature implementations, and overall project sustainability.

For more information and to become a part of the glancecard community, visit the official website.

Engage with glancecard and elevate your GitHub profile visibility while enjoying a visually remarkable interface.