Volver al ranking

kyechan99/capsule-render

TypeScriptcapsule-render.vercel.app

🌈 Dynamic Coloful Image Render

profile-readmereadme-generatorgithub-profileimage-generatordynamic-profiledynamic
Crecimiento de estrellas
Estrellas
1.8k
Forks
730
Crecimiento semanal
Issues
3
5001k1.5k
jul 2020jul 2022jul 2024jul 2026
Artefactosnpmnpm install capsule-render
README


GH Contributors Codecov Issues GH pull requests

English · 한국어 · Español · Français · Deutsch
简体中文 · 繁體中文 · 繁體粤语 · Português (Brasileiro) · 日本語 · മലയാളം · Русский


[!TIP] Supports simple Generator. However, we recommend reading the README for more detailed adjustments.

[!IMPORTANT] This service is provided on a best-effort basis and may be unstable due to usage limits or traffic spikes.

For reliable use, please fork the repository and deploy it to your own Vercel instance (or another hosting platform).

  1. How to Use
  2. Types
  3. Color
  4. Custom Color List
  5. Theme
  6. Section
  7. Reversal
  8. Height
  9. Text
  10. Desc
  11. Text Background
  12. Text Animation
  13. Font Color
  14. FontFamily
  15. Font Size
  16. Font Align - X
  17. Font Align - Y
  18. Desc Size
  19. Desc Align - X
  20. Desc Align - Y
  21. Rotate
  22. Stroke
  23. Stroke-width
  24. Demo

Any of Idea -> Idea-Issue or PR

How to Use

https://capsule-render.vercel.app/api?

Just write query parameter end of this url. Like this

Markdown:

![header](https://capsule-render.vercel.app/api?type=wave&color=auto&height=300&section=header&text=capsule%20render&fontSize=90)

HTML:

<img src="https://capsule-render.vercel.app/api?type=wave&color=auto&height=300&section=header&text=capsule%20render&fontSize=90" />

Types

Type data makes to change Background Image.

Write &type= on the URL

![header](https://capsule-render.vercel.app/api?type=slice)

Color

Change Background Image!

  • &color=auto : Proven random color. List are here
  • &color=timeAuto : Proven random color, but is decided by time.
  • &color=random : Really random color. I don't know what colors are showing.
  • &color=gradient : Proven random gradient. List are here
  • &color=timeGradient : Proven random gradient, but is decided by time.
  • &color=_hexcode : default(#B897FF)
  • &color=_custom_gradient : Custom gradient. If write as &color=0:EEFF00,100:a82da8, it will be converted to { 0%: 'EEFF00', 100%: 'a82da8' }. (e.g. DEMO)

If you use auto mode. no need to change fontColor. auto also change fontColor auto.

![header](https://capsule-render.vercel.app/api?color=auto)

If you use static color. Do not write '#'

When use timeAuto and timeGradient?

Used section header and footer at the same time.

Custom Color List

You can customize the list of colors that will appear randomly only for &color=auto and &color=gradient.

Write &customColorList= on the URL.

Pick the color patterns you want and remember the idx value.

For example, if the idx values ​​are 0, 2, and 3, write: &customColorList=0,2,3

If you want to make many apperances of idx=2, you can write them repeatedly. (e.g. &customColorList=0,2,2,2,2,3)

![header](https://capsule-render.vercel.app/api?color=gradient&customColorList=0,2,2,5,30)

Theme

You can use the specified combination using theme=.

Even if color and fontColor are used, theme has the highest priority.

Check the list of available themes at pallete_theme.json.

![reversal](https://capsule-render.vercel.app/api?type=rect&text=RECT&fontAlign=30&fontSize=30&desc=Use%20theme&descAlign=60&descAlignY=50&theme=radical)

I'm currently adding combinations from the Link:theme little by little.

Section

Section data makes reverse Background Image.

  • &section=header : (default)
  • &section=footer

Write &section= on the URL

![footer](https://capsule-render.vercel.app/api?section=footer)

Reversal

Reverse the image left and right. (Color at the same time)

  • &reversal=false : (default)
  • &reversal=true
![reversal](https://capsule-render.vercel.app/api?type=slice&reversal=true&color=gradient)

Height

Change Image Size. Default value is 120.

Write &height= on the URL

![header](https://capsule-render.vercel.app/api?height=400)

Do not write px

Text

Input text over the Image.

Write Something &text= .

![header](https://capsule-render.vercel.app/api?text=Hello%World!)

You can't use some Special Characters. Like '#', '&', '/' ...

It makes confused API

It is recommended to use %20 (blank) and -nl- (new line) only

Desc

Input desc over the Image.

Write Something &desc= .

![header](https://capsule-render.vercel.app/api?height=400&text=Hello%20World!&desc=Hello%20capsule%20render)

You can't use some Special Characters. Like '#', '&', '/' ...

It makes confused API

It is recommended to use %20 (blank) and -nl- (new line) only

Text Background

Background of Text.

Write &textBg=true to active.

If you want to increase background-size, add %20 between text values. This is because background-size depends on the length of the english-text. (%20 means spacing)

![header](https://capsule-render.vercel.app/api?type=rounded&color=gradient&text=%20asdf%20&height=300&fontSize=100&textBg=true)

Text Animation

Make the text dynamic.

Write &animation= , if you want to use.

  • fadeIn : fadeIn 1.2s
  • scaleIn : scaleIn .8s
  • blink : blink .6s
  • blinking : blinking 1.6s
  • twinkling : twinkling 4s
![header](https://capsule-render.vercel.app/api?text=capsule_render&animation=fadeIn)

FontColor

Change text color. Default value is 000000.

Value should be Hex code with erased '#'

Write &fontColor= behind Text query

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontColor=d6ace6)

FontFamily

Change text font family.

Write &fontFamily= behind Text query.

Use %20 for spaces in font names.

fontFamily is applied as CSS font-family, but actual rendering depends on fonts available in the rendering environment. If a font is unavailable, fallback fonts are used.

![header](https://capsule-render.vercel.app/api?text=Hello%20World!&fontFamily=Segoe%20UI)

FontSize

Change text font size. Default value is 70.

Write &fontSize= behind Text query

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontSize=40)

Do not write px

FontAlign

Change text horizontal-align (x). write number between 0~100

&fontAlign= : Default value is 50. center of image

In case there are multiple lines in &text= (-nl-), providing multiple &fontAlign= will apply different horizontal-align to each line individually.

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontAlign=70)

FontAlignY

Change text vertical-align (y). write number between 0~100

&fontAlignY= : Default value for one line is 50 (center of image). For multiple lines (separated by -nl-), default will be calculated to get lines stacked on top of each other and centered.

In case there are multiple lines in &text= (-nl-), providing multiple &fontAlignY= will apply different vertical-align to each line individually.

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontAlignY=20)

DescSize

Change desc font size. Default value is 20.

Write &descSize= behind desc query

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontSize=40&desc=Desc&descSize=30)

Do not write px

DescAlign

Change desc horizontal-align (x). write number between 0~100

&descAlign= : Default value is 50. center of image

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontAlign=70&desc=Desc&descAlign=20)

DescAlignY

Change text vertical-align (y). write number between 0~100

&descAlignY= : Default value is 60. center of image

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontAlignY=20&desc=Desc&descAlignY=40)

Rotate

Usage &rotate= , to rotate text.

You can also use negative number.

Recommend number arrange. ☞ 0 ~ 360, 0 ~ -360.

![header](https://capsule-render.vercel.app/api?text=Hello%World!&fontSize=20&rotate=-30)

Stroke

Change text stroke.

Write &stroke= behind query

Value should be Hex code with erased '#'

![header](https://capsule-render.vercel.app/api?type=rect&height=200&text=Stroke%20Test&fontAlign=70&stroke=00FF00)

Recommended to use with strokeWidth.

When used alone, strokeWidth defaults to 1.

Stroke-width

Change text stroke width.

Write &strokeWidth= behind stroke query

Value must be greater than or equal to 0.

![header](https://capsule-render.vercel.app/api?type=rect&height=200&text=Stroke%20Test&fontAlign=70&stroke=00FF00&strokeWidth=3)

Recommended to use with stroke.

When used alone, stroke defaults to 'B897FF'.

Demo

Wave

wave

Egg

egg

Shark

shark

Slice

slice

Rect

rect

Soft

soft

Rounded

rounded

Cylinder

cylinder

Waving

waving

Transparent

transparent

Venom

venom

Speech

speech

Blur

blur

Pulse

pulse

Checkered

checkered


Repositorios relacionados
anuraghazra/github-readme-stats

:zap: Dynamically generated stats for your github readmes

JavaScriptnpmMIT Licenseprofile-readmedynamic
github-readme-stats.vercel.app
79.8k35.5k
abhisheknaiidu/awesome-github-profile-readme

😎 A curated list of awesome GitHub Profile which updates in real time

Creative Commons Zero v1.0 Universalawesome-listawesome
bit.ly/awesome-gh
30.6k4.4k
lowlighter/metrics

📊 An infographics generator with 30+ plugins and 300+ options to display stats about your GitHub account and render them as SVG, Markdown, PDF or JSON!

JavaScriptnpmMIT Licensereadmemetrics
metrics.lecoq.io
16.9k2.2k
avgupta456/github-trends

🚀 Level up your GitHub profile readme with customizable cards including LOC statistics!

PythonPyPIMIT Licensegithubreadme-stats
githubtrends.io
16k116
rzashakeri/beautify-github-profile

This repository will assist you in creating a more beautiful and appealing github profile, and you will have access to a comprehensive range of tools and tutorials for beautifying your github profile. 🪄 ⭐

Creative Commons Zero v1.0 Universalgithubgithub-profile
12.4k658
DenverCoder1/readme-typing-svg

⚡ Dynamically generated, customizable SVG that gives the appearance of typing and deleting text for use on your profile page, repositories, or website.

PHPPackagistMIT Licensedynamicreadme
readme-typing-svg.demolab.com
9.1k1.6k
DenverCoder1/github-readme-streak-stats

🔥 Stay motivated and show off your contribution streak! 🌟 Display your total contributions, current streak, and longest streak on your GitHub profile README

PHPPackagistMIT Licenseprofileprofile-readme
streak-stats.demolab.com
7k1.6k
antonkomarev/github-profile-views-counter

It counts how many times your GitHub profile has been viewed. Free cloud micro-service.

PHPPackagistMIT Licensegithubgithub-profile
komarev.com/sources/github-profile-views-counter
5k422
maurodesouza/profile-readme-generator

🎨 Enhance your GitHub profile with this amazing tool, which allows you to create a personalized README quickly and easily. This profile README generator is the best you'll find 🚀

TypeScriptnpmMIT Licenseprofileprofile-readme-generator
profile-readme-generator.com
4.3k2.3k
anmol098/waka-readme-stats

This GitHub action helps to add cool dev metrics to your github profile Readme

PythonPyPIMIT Licenseawesomeprofile-readme
4k639
vn7n24fzkq/github-profile-summary-cards

A tool to generate your GitHub summary card for profile README

TypeScriptnpmMIT Licenseprofile-summarygithub-action
github-profile-summary-cards.vercel.app/demo
3.6k492
gautamkrishnar/blog-post-workflow

Show your latest blog posts from any sources or StackOverflow activity or Youtube Videos on your GitHub profile/project readme automatically using the RSS feed

JavaScriptnpmGNU Affero General Public License v3.0rssrss-feed
github.com/marketplace/actions/blog-post-workflow
3.4k290