mermaid cli 다운로드 -Mermaid mermaid cli 소스 코드 다운로드

mermaid cli

기타 소스코드

11.4.0

다운로드

인어 클리

이것은 Mermaid의 명령 줄 인터페이스 (CLI)입니다. 인어 정의 파일을 입력으로 사용하고 SVG/PNG/PDF 파일을 출력으로 생성합니다.

설치

npm install -g @mermaid-js/mermaid-cli

용법

인어 MMD 다이어그램 파일을 SVG로 변환하십시오

mmdc -i input.mmd -o output.svg

메모
전 세계적으로 패키지를 설치하지 않으려면 대체 설치를 참조하십시오.
선호하는 방법을 위해 MMDC 실행 파일을 호출하는 방법을 찾으십시오. IE Docker, 원사, NPM, 로컬 설치 등.

예

어두운 테마와 투명한 배경으로 PNG를 만듭니다.

mmdc -i input.mmd -o output.png -t dark -b transparent

사용자 정의 CSS로 SVG 파일을 애니메이션합니다

--cssFile 옵션을 사용하여 일부 사용자 정의 CSS를 인화 할 수 있습니다.

애니메이션이있는 CSS 파일의 예는 ./test-positive/flowchart1.css를 참조하십시오.

경고 : mermaid 의 themeCSS 무시하려면 Mermaid --configFile )에 {"themeCSS": "..."}) 추가하는 것이 좋습니다. Mermiad의 themeCSS 무시하려면 !important

경고 : Inline CSS 파일은 SVG를 호스팅하는 웹 사이트의 HTTP Content-Security-Policy 헤더에 따라 브라우저에서 차단할 수 있습니다.

mmdc --input test-positive/flowchart1.mmd --cssFile test-positive/flowchart1.css -o docs/animated-flowchart.svg

예제 출력 : 문서/애니메이션-플로 치트 .svg

인어 다이어그램으로 마크 다운 파일을 변환하십시오

mmdc -i readme.template.md -o readme.md

이 명령은 Markdown 파일 자체를 변환합니다. 인어 클라이는 인어 다이어그램을 찾아서 SVG 파일을 만들고 마크 다운 출력의 파일을 참조합니다.

이것:

 ### Some markdown
``` mermaid
graph
   [....]
```

### Some more markdown
``` mermaid
sequenceDiagram
   [....]
```

### Mermaid with custom title/desc
``` mermaid
graph
   accTitle: My title here
   accDescr: My description here
   A-->B
```

:

 ### Some markdown
![ diagram ] ( ./readme-1.svg )

### Some more markdown
![ diagram ] ( ./readme-2.svg )

### Mermaid with custom title/desc
![ My description here ] ( ./readme-3.svg " My title here ")

Stdin에서 배관

Stdin에서 입력을 쉽게 파이프 할 수 있습니다. 이 예제는 Heredoc을 사용하여 다이어그램을 MMDC (Mermaid-Cli)로 보내는 방법을 보여줍니다.

cat << EOF  | mmdc --input -
    graph TD
    A[Client] --> B[Load Balancer]
EOF

사용 가능한 모든 옵션을 참조하십시오

mmdc -h

대체 설치

Docker/Podman 사용 :

docker pull minlag/mermaid-cli

또는 Github 컨테이너 레지스트리에서 당겨집니다

docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli

또는 예를 들어 버전 8.8.0

docker pull minlag/mermaid-cli:8.8.0

컨테이너는 /data 의 입력 파일을 찾습니다. 예를 들어, /path/to/diagrams/diagram.mmd 의 시스템에 정의 된 다이어그램이있는 경우 컨테이너를 사용하여 다음과 같이 SVG 파일을 생성 할 수 있습니다.

docker run --rm -u ` id -u ` : ` id -g ` -v /path/to/diagrams:/data minlag/mermaid-cli -i diagram.mmd

또는 Podman을 사용하는 경우 대신 :

podman run --userns keep-id --user ${UID} --rm -v /path/to/diagrams:/data:z ghcr.io/mermaid-js/mermaid-cli/mermaid-cli -i diagram.mmd

Podman 명령과 Docker 명령의 주요 차이점은 다음과 같습니다.

--userns keep-id 인수의 추가. 이를 통해 컨테이너는 서브 우드에 매핑하는 대신 컨테이너 네임 스페이스에서 현재 사용자의 UID와 동일한 UID를 유지할 수 있습니다. 문서는 여기에서 찾을 수 있습니다
부피 매핑 끝에 :z 를 추가합니다. 이를 통해 Podman은 Selinux 레이블 container_file_t 사용하여 볼륨의 파일을 RELABEL로 지시합니다. 이는 컨테이너의 프로세스가 파일에 액세스 할 수 있습니다. 자세한 내용은 여기에서 "레이블 볼륨 마운트"섹션을 참조하십시오.

이전 버전에서는 입력 파일이 /home/mermaidcli 에 장착되었습니다. --workdir 옵션 으로이 동작을 복원 할 수 있습니다.

docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...]

Node.js API를 사용하십시오

Node.js API를 통해 mermaid-cli 호출 할 수 있습니다. mermaid-cli mermaid 의 버전을 따르기 때문에 Nodejs API는 SEMVER로 덮여 있지 않습니다 .

 import { run } from "@mermaid-js/mermaid-cli"

await run (
   "input.mmd" , "output.svg" , // {optional options},
)

로컬로 설치하십시오

어떤 사람들은이 도구를 전 세계적으로 설치하는 데 문제가 있습니다. 로컬로 설치하는 것은 대체 솔루션입니다.

 npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h

또는 NPM 사용 :

 npm install @mermaid-js/mermaid-cli
./node_modules/.bin/mmdc -h

NPX로 실행하십시오

npx 기본적으로 NPM으로 설치됩니다. 동시에 명령을 다운로드하고 실행합니다. NPX와 함께 인어 CLI를 사용하려면 패키지 이름이 설치 한 명령 ( mmdc )과 다르므로 -p 플래그를 사용해야합니다. npx -p @mermaid-js/mermaid-cli mmdc -h