Skip to content

sblabkribb/bf_workflow_diagram

Repository files navigation

LabNote 워크플로우 다이어그램 뷰어

labnote 폴더 내에 구조화된 연구노트(.md 파일)들을 파싱하여, 전체 실험 흐름을 한눈에 파악할 수 있는 워크플로우 다이어그램을 시각화하는 VS Code 확장 프로그램입니다.

✨ 주요 기능

  • 워크플로우 시각화: README.md와 각 워크플로우 파일을 분석하여 실험의 전체 흐름을 다이어그램으로 보여줍니다.
  • 자동 DBTL 사이클 할당: 워크플로우 제목('WD', 'WB' 등)에 따라 자동으로 Design-Build-Test-Learn 사이클에 할당하고, 색상으로 구분하여 실험 단계를 시각적으로 그룹화합니다.
  • 소스 코드 연동: 다이어그램의 각 노드(워크플로우, 유닛 오퍼레이션)를 클릭하면 해당 마크다운 파일의 소스 코드 위치로 즉시 이동합니다.
  • 자동 새로고침: 실험 폴더 내의 .md 파일이 변경되면 다이어그램이 자동으로 업데이트되어 항상 최신 상태를 유지합니다.
  • PNG 내보내기: 생성된 다이어그램을 PNG 이미지 파일로 내보내어 보고서나 프레젠테이션에 활용할 수 있습니다.
  • 어디서든 실행: 실험 폴더(labnote/EXPERIMENT_NAME/) 내의 어떤 마크다운 파일(README.md 또는 워크플로우 파일)에서든 명령어를 실행할 수 있습니다.

🚀 사용 방법

  1. labnote 실험 폴더 내의 README.md 또는 워크플로우 .md 파일을 엽니다.
  2. 명령어 팔레트(Ctrl+Shift+P 또는 Cmd+Shift+P)를 열고 LabNote: 워크플로우 다이어그램 보기를 실행합니다.
  3. 편집기 옆에 새로운 탭으로 다이어그램이 나타납니다.
  4. 다이어그램의 노드를 클릭하여 해당 소스 코드로 이동할 수 있습니다.
  5. 워크플로우 제목에 포함된 키워드(WD, WB, WT, WL)에 따라 DBTL 사이클이 자동으로 할당되며, 각 사이클은 다른 배경색으로 표시됩니다.
  6. 우측 상단의 Export to PNG 버튼을 눌러 현재 다이어그램을 이미지 파일로 저장할 수 있습니다.

📄 파일 구조 요구사항

다이어그램을 올바르게 생성하기 위해 마크다운 파일들은 다음 구조를 따라야 합니다.

1. 실험 README.md

  • YAML Front Matter: 파일 상단에 title 속성으로 실험 제목을 명시해야 합니다.
  • 워크플로우 링크: 본문에 워크플로우 파일로 연결되는 마크다운 링크([링크 텍스트](./파일.md))가 순서대로 포함되어야 합니다.
---
title: DmpR sensor design
---

# 나의 실험 노트

- [WD070 Vector Design](./001_WD070_Vector_Design.md)
- [WB000 Material Preparation](./002_WB000_Material_Preparation.md)

2. 워크플로우 .md 파일

  • YAML Front Matter: 파일 상단에 title 속성으로 워크플로우의 전체 제목을 명시해야 합니다.
  • 유닛 오퍼레이션: ### (H3) 헤딩을 사용하여 [ID] 이름 형식으로 유닛 오퍼레이션을 순서대로 작성해야 합니다. (예: ### [UHW0010] Manual (Dilute))

About

bf workflow visualizer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published