Elevate your GitHub README with beautiful, customizable, and animated ASCII art profile cards.
- 🎨 100% SVG & CSS Animations: No external images, ensuring perfect compatibility with GitHub's strict Markdown Camo proxy.
- ⚡ Zero Database Needed: Everything is generated dynamically on the fly via URL parameters.
- 🖼️ Image to ASCII Magic: Automatically converts your GitHub avatar (or any custom image URL) into beautiful colored ASCII art.
- 🛠️ Deeply Customizable: Add custom fields, change themes, toggle borders, adjust animation speeds, and hide specific data blocks.
- 🕶️ Live Preview Editor: Includes a stunning dark-mode GUI to configure your card visually and instantly copy the markdown code.
Using Asciify is as simple as adding an image tag to your GitHub README.md. You don't need to install anything!
(Note: Replace <your-vercel-domain> with your actual deployed Vercel URL, and swap out the username!)
You can append these parameters to the API URL to deeply customize your card:
| Parameter | Type | Default | Description |
|---|---|---|---|
username |
string | required | Your GitHub username to fetch stats and avatar. |
theme |
string | dark |
Pre-built color themes: dark, light, hacker, dracula, monokai. |
text_color |
hex | (theme based) | Override the primary text color (e.g., %23d97706). |
card_font |
string | monospace |
Try 'Fira Code', 'JetBrains Mono', or 'Fantasque Sans Mono'. |
avatar_style |
string | colored |
Options: colored, grayscale, sepia. |
border_style |
string | solid |
Options: solid, dashed, dotted, none. |
border_color |
string | default |
Give the border a specific CSS color. |
bg_style |
string | solid |
Options: solid, transparent, glass. |
anim_speed |
number | 8 |
The duration (in seconds) of the matrix rain animation. |
hide_repos |
boolean | false |
Pass true to hide the repository count. (Works for all base fields: hide_name, hide_bio, etc.) |
You can add up to 5 custom key-value pairs (like your Discord tag, Spotify status, or Tech Stack) using custom_key_X and custom_val_X:
?custom_key_1=Discord&custom_val_1=MyUsername%231234&custom_key_2=Stack&custom_val_2=Next.js%20%2B%20TailwindWant to run the API or the Live Preview editor locally?
-
Clone the repository:
git clone https://github.com/programmerbeast2004/Asciify.git cd Asciify -
Install dependencies:
npm install
-
Set up Environment Variables: Create a
.env.localfile in the root directory and add your GitHub Personal Access Token to avoid API rate limits:GITHUB_TOKEN=your_github_token_here
-
Run the development server:
npm run dev
Open http://localhost:3000 with your browser to see the Live Preview editor in action!
This project is licensed under the MIT License - see the LICENSE file for details.