Readme typing SVG

About Readme typing SVG

Readme Typing SVG generates a dynamically created SVG that simulates text being typed and deleted, intended for embedding in GitHub profile READMEs, repositories, or websites. It is configured entirely through URL parameters, letting a user set the lines of text to display, dimensions, font size and family, text and background color, alignment, typing duration, pause between lines, and whether the animation loops.

The project offers a hosted demo service for generating the SVG directly, along with a live preview page for adjusting parameters before use. It also provides the option to self-host the underlying PHP files, either on a custom server or deployed as a Heroku app, for users wanting better uptime or more control over customization.

It is built for developers who want to add an animated typing effect to their GitHub profile or project documentation. The project is open source under the MIT license and accepts contributions via issues and pull requests.

Key features

• Generates a dynamically animated SVG that types and deletes customizable text
• Configurable via URL query parameters: lines, height, width, size, font, color, background
• Supports centering (horizontal and vertical), multiline wrapping, and custom letter spacing
• Adjustable typing duration, pause between lines, and repeat/loop behavior
• Live demo site for customizing and previewing the SVG before use
• Self-hostable PHP files, deployable to your own server or Heroku

Frequently asked questions