# GitAscii — GitHub Profile README & ASCII Art Generator

> GitAscii (https://git-ascii.vercel.app) is a free, open-source platform for creating, customizing, and serving dynamic SVG widgets and ASCII art for GitHub profile README.md files.

## Summary & Key Takeaways

GitAscii transforms standard GitHub profiles into visual developer portfolios. It features a drag-and-drop visual editor, real-time live SVG rendering via URL endpoints, custom image-to-ASCII conversion, 13+ handcrafted theme templates, multi-profile management, and dark/light mode automatic switching using HTML `<picture>` elements.

## Key Programmatic Hubs & Resources

- **Templates Catalog**: `https://git-ascii.vercel.app/templates` (13+ theme templates including Terminal, Minimal, Cyberpunk, Dracula, Nord, Tokyo Night, Gruvbox, Matrix, Bento)
- **Dynamic SVG Widgets**: `https://git-ascii.vercel.app/widgets` (Live stats cards, streak counters, language breakdowns, ASCII art banners, tech badges)
- **Developer Directory**: `https://git-ascii.vercel.app/explore` (Public showcase of developer profile READMEs)
- **Guides & Tutorials**: `https://git-ascii.vercel.app/guides` (Step-by-step markdown tutorials and GitHub profile tips)
- **LLM Full Documentation**: `https://git-ascii.vercel.app/llms-full.txt`
- **Sitemap XML**: `https://git-ascii.vercel.app/sitemap.xml`

## Dynamic API Endpoints

- **Profile Editor Route**: `https://git-ascii.vercel.app/[username]`
- **Named Profile Route**: `https://git-ascii.vercel.app/[username]/[profileSlug]`
- **Live SVG Widget Endpoint**: `https://git-ascii.vercel.app/api/[username]`
- **Named Profile SVG Endpoint**: `https://git-ascii.vercel.app/api/[username]/[profileSlug]`
- **Dynamic OG Image Endpoint**: `https://git-ascii.vercel.app/[username]/opengraph-image`

## Usage Example (Markdown Embed)

To add a dynamic GitAscii profile card to a GitHub README.md:

```markdown
![GitAscii Profile](https://git-ascii.vercel.app/api/YOUR_GITHUB_USERNAME)
```

To support automatic dark/light mode switching on GitHub:

```html
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://git-ascii.vercel.app/api/YOUR_GITHUB_USERNAME?theme=github-dark">
  <source media="(prefers-color-scheme: light)" srcset="https://git-ascii.vercel.app/api/YOUR_GITHUB_USERNAME?theme=minimal">
  <img alt="GitAscii Profile" src="https://git-ascii.vercel.app/api/YOUR_GITHUB_USERNAME">
</picture>
```

## Frequently Asked Questions

### What is GitAscii?
GitAscii is a platform for creating premium GitHub Profile READMEs using customizable SVGs and a visual editor.

### Is GitAscii free?
Yes. GitAscii is completely free and open source under the MIT License.

### How does live SVG rendering work?
Instead of uploading static images, developers embed a dynamic URL. GitAscii renders the SVG on-the-fly with live GitHub stats whenever the profile page is loaded.