프로젝트 소개

Mermaid는 Markdown에서 영감을 받은 텍스트 정의와 렌더러를 사용하여 복잡한 다이어그램을 생성하고 수정하는 JavaScript 기반의 다이어그램 및 차트 도구입니다. 이 프로젝트의 주요 목적은 다이어그램을 텍스트로 쉽게 수정할 수 있게 함으로써 문서화가 개발 속도를 따라갈 수 있도록 돕는 것입니다. 이 프로젝트는 MIT 라이선스 하에 오픈 소스로 제공되며 npm 패키지로 배포됩니다. README에는 Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git Graph, Mindmap, Timeline, Sankey를 포함한 20가지 이상의 다이어그램 유형에 대한 지원이 나열되어 있습니다. 다이어그램은 드래그 앤 드롭 도구로 그리는 대신 텍스트로 작성되므로, 코드와 함께 저장하고 버전 관리를 통해 검토할 수 있습니다. 이 프로젝트는 프로토타이핑을 위한 라이브 에디터(mermaid.live)를 제공하며, GitHub의 Markdown에서는 Mermaid 코드 블록이 기본적으로 렌더링됩니다. 또한 다른 애플리케이션 및 문서화 도구와의 통합 기능도 제공합니다. 사용자 정의 옵션으로는 테마, 색상, 글꼴 및 레이아웃 방향 설정이 포함됩니다. 보안을 위해 Mermaid는 내장된 새니타이징 기능과 샌드박스 렌더링 모드를 포함하고 있으며, 이 모드에서는 다이어그램이 샌드박스화된 iframe 내에서 렌더링되어 사용자 콘텐츠에 포함된 JavaScript가 실행되는 것을 방지합니다. README에 따르면 이 모드는 잠재적으로 악성인 코드와 함께 일부 대화형 기능도 차단할 수 있습니다. 이 프로젝트는 무거운 의존성이 없는 경량 도구라고 설명하며, 빈번한 릴리스와 함께 활발한 커뮤니티를 유지하고 있습니다. 관련 프로젝트로는 Command Line Interface, Live Editor 및 HTTP Server가 있습니다. 저장소의 README에는 공식 문서, 시작 가이드, CDN 이용 가능 여부, 튜토리얼 및 기여 가이드가 참조되어 있습니다. Mermaid는 2019년 JS Open Source Awards에서 가장 흥미로운 기술 활용 부문을 수상했습니다.