https://github.com/yagiziskirik/github-colored-text

Create coloured text for Github readme pages
https://github.com/yagiziskirik/github-colored-text

github markdown svg

Last synced: 3 months ago
JSON representation

Create coloured text for Github readme pages

• Host: GitHub
• URL: https://github.com/yagiziskirik/github-colored-text
• Owner: yagiziskirik
• License: mit
• Created: 2022-09-26T16:40:51.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-26T21:03:10.000Z (almost 4 years ago)
• Last Synced: 2025-06-27T01:11:12.060Z (about 1 year ago)
• Topics: github, markdown, svg
• Language: JavaScript
• Homepage: https://github-colored-text-fn3z.vercel.app/api/index.js?text=Welcome
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Github-Colored-Text

![Version 1.0.0](https://img.shields.io/badge/version-1.0.0-blue) ![Licence](https://img.shields.io/badge/Licence-MIT-green)

Create ![](https://github-colored-text-fn3z.vercel.app/api/index?text=coloured&color=00ff00&width=55) text for Github readme pages!

I wanted to make my Github page ![](https://github-colored-text-fn3z.vercel.app/api/index?text=c&color=ff0000&width=8)![](https://github-colored-text-fn3z.vercel.app/api/index?text=o&color=ffa200&width=10)![](https://github-colored-text-fn3z.vercel.app/api/index?text=l&color=bfff00&width=6)![](https://github-colored-text-fn3z.vercel.app/api/index?text=o&color=1eff00&width=10)![](https://github-colored-text-fn3z.vercel.app/api/index?text=u&color=00ff80&width=9)![](https://github-colored-text-fn3z.vercel.app/api/index?text=r&color=00ddff&width=7)![](https://github-colored-text-fn3z.vercel.app/api/index?text=f&color=0040ff&width=7)![](https://github-colored-text-fn3z.vercel.app/api/index?text=u&color=6200ff&width=9)![](https://github-colored-text-fn3z.vercel.app/api/index?text=l&color=ff00ff&width=6), so here is a solution for all of you.

## Usage

You can use the api like this:

```

![API](https://github-colored-text-fn3z.vercel.app/api/index.js?text=YOURTEXTHERE&color=HEXCOLOR&width=TEXTWIDTH&fontSize=FONTSIZE&height=HEIGHT&x=X&y=Y)

```

## Customisation

* text: Your word to be colourised (Default: ''). [CHANGE RECOMMENDED]

* color: Hex color _WITHOUT_ the hashtag (Default: ff0000). [CHANGE RECOMMENDED]

* fontSize: Font size (Default: 17).

* width: Width of the text container (Default: 150). [CHANGE RECOMMENDED]

* height: Height of the text container (Default: fontsize).

* x: X position of the text (Default: 0).

* y: Y position of the text (Default: fontsize).

You can do trial-and-error to get the right settings. I believe it is quite useful for your projects. And you can also check out my [![Github page](https://github-colored-text-fn3z.vercel.app/api/index.js?text=Github+page&color=c09839&width=79&fontsize=17&height=20.4)](https://github.com/yagiziskirik) for the example usage.