MkDocs에서 UML을 보는 방법 정보

MKDocs는 Python의 문서 사이트 생성기입니다.
간단하게 구축할 수 있는데, 마크다운으로 쓸 ​​수 있으므로,
작은 문서의 정적 사이트를 구축하는 데 유용합니다.

그렇다면 Mermaid.js 또는 PlantUML에서 UML을 표시하고 싶습니다.
되는 장면도 많다고 생각합니다.

MKDocs라면 조금만 설정하면
표시가 가능합니다.

MKDocs의 구축은 생략하지만,
다음 패키지를 PyPI에서 설치해야 합니다.

pip install pymdown-extensions 

Mermaid.js 설정 방법

mkdocs.yml에서 다음 설정만 하면 됩니다.

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format

extra_css:
  - https://unpkg.com/[email protected]/dist/mermaid.css

extra_javascript:
  - https://unpkg.com/[email protected]/dist/mermaid.min.js

superfences에서 코드 블록의 이름이 mermaid 인 것을
클래스 이름을 mermaid로 설정하면
그리기를 실현할 수 있는 것 같습니다.

그린 결과는 다음과 같습니다.

PlantUML 설정 방법

PyPI에서 plantuml-markdown 설치

pip install plantuml-markdown

mkdocs.yml에서 다음 설정을 구성합니다.

markdown_extensions:
  - plantuml_markdown:
      server: http://www.plantuml.com/plantuml

plantuml-markdown은 그리기를 수행하는 서버
설정해야합니다.



또한 서버는 로컬로 구축 할 수 있으며,
docker 명령으로 쉽게 만들 수 있습니다.

PlantUML Server

위와 같이 설정만 하면 UML을 표시할 수 있습니다.

MKDocs는 템플릿도 많고 매우 사용하기 쉬운 문서 사이트 생성기이므로
꼭 사용해보십시오.

<참고 사이트>
htps : // 기주 b. 코 m / s 쿠이 d 훗 k / mk 드 cs - 테리 아 l / 이스에 s / 693
htps : // 푹 헷 쏟아 r. 기주 b. 이오 / pym 드 w 응 x 텐시 온 s / 에 x 텐시 온 s / 슈페르 펜션 s /
htps : // 기주 b. 코 m / 미키 테 x70 / p