Introduction

Welcome to GitAscii

GitAscii is an open-source visual editor and SVG engine for GitHub profile READMEs. Design a composition in the browser, then publish it to your own username/username repository. Version 2 serves the normal README image from GitHub rather than rendering it on every profile visit.

Visual editor → SavedConfiguration → initial dark/light SVG render
                                      ↓
                         username/username:gitascii
                         gitascii.json + profiles/default/*.svg
                                      ↓
                README <picture> → raw.githubusercontent.com
                                      ↑
                    GitHub Action refreshes published SVGs

The editor installs .github/workflows/gitascii.yml on the repository’s default branch. The workflow reads the configuration files on gitascii, fetches fresh GitHub data, renders both themes, inlines permitted external assets, and commits updated SVGs atomically. The initial publish renders the first files immediately. The HTTP API and TypeScript engine remain available for previews and custom integrations.

Quickstart

Publish your first profile and copy the GitHub-hosted README embed.

API Overview

Explore the optional HTTP routes and the programmatic SVG engine.

Widget Catalog

Discover the widgets available in the visual editor and renderer.

JSON Schema

Understand the configuration stored on the gitascii branch.

Where each piece runs

Component	Role
GitAscii web app	Editor, GitHub App authorization, initial publish, Pro management, and optional HTTP rendering API.
`gitascii` branch	Source configurations and published `profiles/[slug]/dark.svg` and `light.svg`.
GitHub Action	Scheduled or manual refresh of every configured profile from current GitHub data.
Profile `README.md`	`<picture>` sources point at stable raw GitHub URLs and select the viewer’s theme.
Pro analytics badge	Separate GitAscii endpoint that counts observed badge fetches; it cannot identify README visitors.

Getting Started

API

GitAscii Pro

Widgets Overview

Essential Widgets

Interactive & ASCII

Stats & Metrics

GodProfile Suite

ASCII Profile Suite

Control Plane Suite

Codeweb Aura Suite

External Integrations

Templates

Guides

Reference

Welcome to GitAscii

Quickstart

API Overview

Widget Catalog

JSON Schema

Where each piece runs

​Welcome to GitAscii

Quickstart

API Overview

Widget Catalog

JSON Schema

​Where each piece runs

Welcome to GitAscii

Where each piece runs