Skip to content

jongeuni/markdown-box-generator

Repository files navigation

box
You can check the README of English 👉 Document of English

markdown-box-generator

원하는 정보를 담은 박스를 만들어주는 간단한 서비스입니다.
아래에서 box-generator 사용 방법과 테마 정보를 확인하실 수 있습니다.


사용 방법

[![box](https://markdown-box-generator.vercel.app/api/box?title=Default_Title&author=Author&date=2025-7-28&style=default)](https://github.com/jongeuni/markdown-box-generator)

🔍 param

  • title
  • author
  • date
  • style

Important

값을 전달하지 않을 경우 기본 값이 들어갑니다.

Caution

띄어쓰기의 경우 _ 또는 %20을 사용해 주세요.
ex: ?title=뱃지_제목_입니다 or ?title=뱃지%20제목%20입니다.
그냥 띄어쓰기를 하실 경우 요청이 가지 않습니다.


박스 스타일 정보

테마 스타일 타입은 src/themes/BoxStyleType.ts에 정의되어있습니다.

제목 요청 타입
티스토리 스타일 TISTORY
브런치 스타일 BRUNCH
인스타그램 스타일 INSTA
링크드인 스타일 LIINKED
기본 스타일 DEFAULT

- 티스토리 스타일 (TISTORY)

box

- 브런치 스타일 (BRUNCH)

box

- 인스타그램 스타일 (INSTA)

box

- 링크드인 스타일 (LIINKED)

box

About

Customize your GitHub README with stylish boxes in Markdown.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published