Repolode
obsidianmd

obsidianmd/pele

런타임 의존성 없이 Mermaid 다이어그램 텍스트를 SVG로 변환하는 경량 동기식 렌더러입니다.

스타
2,476
포크
74
열린 이슈
23
마지막 커밋
12시간 전

어떤 프로젝트인가요?

Pele은 Mermaid 다이어그램 소스를 SVG로 렌더링합니다. Mermaid 12.1.0 문법을 대상으로 하며, 해당 버전에 내장된 모든 다이어그램 유형을 지원합니다. 단, Mermaid의 레이아웃과 시각적 스타일을 따르는 대신 자체 방식을 사용합니다.

렌더링은 동기식이며 런타임 의존성이 없습니다. 색상과 글꼴은 CSS 변수로 제어하므로 다이어그램이 페이지의 테마를 따르고, 다시 렌더링하지 않아도 테마 변경에 맞춰 업데이트됩니다. 브라우저에서는 mount helper를 사용해 요소 안에 렌더링하고, CSS에서 글꼴을 읽으며, 컨테이너 너비에 맞게 레이아웃을 조정할 수 있습니다. 기본 진입점에는 모든 다이어그램 유형이 포함되지만, 번들 크기를 줄이기 위해 개별 유형을 등록하거나 필요할 때 불러올 수 있습니다.

이 프로젝트는 다이어그램 텍스트를 이스케이프하고 링크와 스타일을 필터링하며, 입력과 출력의 크기를 제한합니다. 신뢰할 수 없는 다이어그램을 처리하는 방법도 안내합니다. npm으로 배포되며 CDN에서 전역 스크립트로 불러올 수도 있습니다.

핵심 기능

  • 01Mermaid 12.1.0에 내장된 모든 다이어그램 유형을 SVG로 렌더링합니다.
  • 02런타임 의존성이 없으며 동기식으로 렌더링합니다.
  • 03테마 변경에 따라 업데이트되는 CSS 변수로 색상과 글꼴을 지정합니다.
  • 04컨테이너 너비에 맞게 레이아웃을 조정하는 브라우저용 mount helper를 제공합니다.
  • 05번들 크기를 줄이도록 개별 다이어그램 유형을 필요할 때 불러올 수 있습니다.
  • 06신뢰할 수 없는 입력에 대비해 텍스트를 이스케이프하고 링크와 스타일을 필터링합니다.

활용 사례

  • 무거운 의존성 없이 웹 페이지나 문서 사이트에서 Mermaid 다이어그램을 렌더링할 때.
  • CSS를 통해 사이트의 라이트 또는 다크 테마를 따르는 다이어그램을 삽입할 때.
  • 서버나 빌드 도구에서 Mermaid 텍스트로 SVG 다이어그램을 생성할 때.
  • 페이지에서 사용하는 다이어그램 유형만 불러와 JavaScript 페이로드를 줄일 때.

빠른 시작

  1. 1

    패키지를 설치합니다

    npm install pele
  2. 2

    render를 가져와 Mermaid 텍스트를 SVG로 변환합니다

사용 전 알아둘 점

  • README에는 라이선스가 명시되어 있지 않습니다. 메타데이터에는 NOASSERTION으로 표시되어 있지만 README에서는 MIT를 언급합니다.
  • Pele은 자체 레이아웃과 시각적 스타일로 Mermaid 12.1.0 구문을 대상으로 하므로 출력이 Mermaid와 다를 수 있습니다.

토픽

자주 묻는 질문

pele은(는) 무엇인가요?
런타임 의존성 없이 Mermaid 다이어그램 텍스트를 SVG로 변환하는 경량 동기식 렌더러입니다. Pele은 Mermaid 다이어그램 소스를 SVG로 렌더링합니다. Mermaid 12.1.0 문법을 대상으로 하며, 해당 버전에 내장된 모든 다이어그램 유형을 지원합니다. 단, Mermaid의 레이아웃과 시각적 스타일을 따르는 대신 자체 방식을 사용합니다.
pele은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
pele은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
pele은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. pele의 마지막 커밋은 2026년 10월 19일입니다.
pele은(는) 어디에 사용할 수 있나요?
무거운 의존성 없이 웹 페이지나 문서 사이트에서 Mermaid 다이어그램을 렌더링할 때. CSS를 통해 사이트의 라이트 또는 다크 테마를 따르는 다이어그램을 삽입할 때. 서버나 빌드 도구에서 Mermaid 텍스트로 SVG 다이어그램을 생성할 때. 페이지에서 사용하는 다이어그램 유형만 불러와 JavaScript 페이로드를 줄일 때.
pele는 어떻게 설치하나요?
패키지를 설치합니다: npm install pele render를 가져와 Mermaid 텍스트를 SVG로 변환합니다
pele은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/obsidianmd/pele

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트