https://github.com/42lm/svg-github-readme

Generate SVG's 🎇 with dynamic content for github flavoured markdown files
https://github.com/42lm/svg-github-readme

github-readme github-readme-profile markdown md svg svg-animation vercel

Last synced: 5 months ago
JSON representation

Generate SVG's 🎇 with dynamic content for github flavoured markdown files

• Host: GitHub
• URL: https://github.com/42lm/svg-github-readme
• Owner: 42LM
• License: mit
• Created: 2023-12-04T16:19:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-13T13:12:47.000Z (over 1 year ago)
• Last Synced: 2024-11-13T09:13:39.406Z (8 months ago)
• Topics: github-readme, github-readme-profile, markdown, md, svg, svg-animation, vercel
• Language: Go
• Homepage: https://svg-github-readme.vercel.app/api?type=animated_text&text=Hello,%20World!&font_size=200&color=8ACDD7
• Size: 23.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Test](https://github.com/lmllrjr/svg-github-readme/actions/workflows/test.yaml/badge.svg)](https://github.com/lmllrjr/svg-github-readme/actions/workflows/test.yaml)

![](https://svg-github-readme.vercel.app/api?type=static_text&color=46C2CB&font_size=100&text=svg-github-readme%20📰)

svg-github-readme provides a simple solution of creating custom SVG's (e.g. headings, eye-catching content ...) in your github readme file.

Table of Contents:  

 * [Animated Text](#animated-text)

 * [Static Text](#static-text)

## Animated Text

### Examples

![](https://svg-github-readme.vercel.app/api?type=animated_text&text=Animated%20Text&color=E26EE5&font_size=50&font_family=Open%20Sans)

#### Full example query

```markdown

![](https://svg-github-readme.vercel.app/api?type=animated_text&text=helloworld&color=161A30&font_size=100&font_family=Arial)

```

#### Minimal example query

> [!IMPORTANT]

> The `text` query param is not mandatory, but nothing will be displayed when no text is provided.

```markdown

![](https://svg-github-readme.vercel.app/api?type=animated_text&text=helloworld)

```

### Query paremters

| Query Paremeter name | Example Value | Mandatory |

|----------------------|--------------:|----------:|

| type                 | animated_text | true      |

|                      |               |           |

| color                |        00ADD8 | false     |

| font_family          |       fantasy | false     |

| font_size            |           200 | false     |

| text                 | hello%20world | false     |

## Static Text

![](https://svg-github-readme.vercel.app/api?type=static_text&text=Static%20Text&color=FFA732&font_size=50&font_family=Open%20Sans)

### Examples

#### Full example query

```markdown

![](https://svg-github-readme.vercel.app/api?type=static_text&text=helloworld&color=FFA732&font_size=100&font_family=Courier)

```

#### Minimal example query

> [!IMPORTANT]

> The `text` query param is not mandatory, but nothing will be displayed when no text is provided.

```markdown

![](https://svg-github-readme.vercel.app/api?type=static_text&text=helloworld)

```

### Query paremters

| Query Paremeter name | Example Value | Mandatory |

|----------------------|--------------:|----------:|

| type                 | static_text   | true      |

|                      |               |           |

| color                |        FFA732 | false     |

| font_family          |       courier | false     |

| font_size            |           200 | false     |

| text                 | hello%20world | false     |

## Malformed query will result in an error svg

![](https://svg-github-readme.vercel.app/api?text=helloworld)

> `![](https://svg-github-readme.vercel.app/api?text=helloworld)`