Markdown 문서
Markdown 문서는 spec, 설계 노트, runbook, 회의록처럼 ERD, diagram, OpenAPI 명세와 같은 project 안에 함께 보관할 텍스트 문서입니다.
Markdown 문서 생성
Markdown 문서는 다른 AI-ERD 문서와 같은 생성 흐름을 사용합니다.
- 상단 File > New Document 를 열거나 project/folder의 새 문서 액션을 클릭합니다.
- 대상 project와 필요한 경우 folder를 선택합니다.
- 문서 타입으로 Markdown 을 선택합니다.
- title을 입력하고 문서를 생성합니다.
문서는 새 탭으로 열립니다. folder 안에서 만들면 project tree의 해당 folder 아래에 표시됩니다.
읽기와 편집
Markdown 문서는 읽기 모드로 열립니다. viewer는 heading, list, table, link, code block 등 Markdown 내용을 렌더링합니다.
오른쪽 rail에서 문서 도구를 사용할 수 있습니다.
| 패널 | 용도 |
|---|---|
| TOC | 현재 문서의 heading으로 이동 |
| Versions | 저장된 버전 확인 및 이전 버전 복원 |
| Share | 문서 공유와 public link 관리 |
| Meta | 문서 metadata 확인 |
| Style | 읽기 화면 조정 |
문서를 편집하려면:
- 본문 편집 액션을 클릭하거나
Ctrl+E/Cmd+E를 누릅니다. - Markdown editor에서 title 또는 body를 수정합니다.
- Save 를 클릭하거나
Ctrl+S/Cmd+S를 누릅니다.
변경사항은 Save 를 실행할 때 저장됩니다. 그전까지는 탭에 unsaved 상태가 표시되며, 변경을 버리려 하면 확인을 요청합니다.
버전과 복원
오른쪽 rail의 Versions 패널에서 최근 버전을 볼 수 있습니다. 전체 목록과 비교 흐름은 View All 에서 엽니다.
Markdown version은 저장된 문서 상태에서 생성됩니다. 각 version에는 다음 정보가 기록됩니다.
- version number
- 생성 시각
- 생성자
- change summary 또는 title
- 해당 version의 Markdown snapshot
버전을 복원하려면:
- 오른쪽 rail에서 Versions 를 엽니다.
- 대상 version의 Restore 를 클릭합니다.
- 복원을 확인합니다.
복원은 선택한 version의 title과 Markdown body를 현재 문서에 다시 씁니다. 복원 자체도 새 version으로 기록되므로, 복원 직전 상태도 history에 남습니다.
Version history 보관은 요금제 한도를 따릅니다. 한도에 도달하면 오래된 version이 잠기거나 사용할 수 없을 수 있습니다.
AI Chat으로 편집
Markdown 문서가 활성 탭이면 AI Chat 이 현재 문서 본문과 선택한 텍스트를 읽을 수 있습니다. rewrite, expand, summarize, polish, replace 같은 작업을 요청할 수 있습니다.
문서 편집 요청에서 AI Chat은 전체 문서 교체안을 준비합니다.
- Markdown 문서가 활성화된 상태에서 요청을 보냅니다.
- assistant가 다음 title과 Markdown body를 작성합니다.
- preview dialog에서 현재 버전과 제안된 다음 버전을 비교합니다.
- 확인하면 저장되고, 취소하면 문서는 변경되지 않습니다.
프롬프트를 보낸 뒤 문서가 다른 곳에서 변경되면 AI-ERD는 조용히 덮어쓰지 않고 conflict dialog를 엽니다. dialog에는 사용자가 시도한 내용, 최신 서버 내용, 편집 가능한 merge 영역이 표시됩니다. 한쪽을 선택하거나 merge를 직접 수정한 뒤 저장하세요.
공유된 read-only 문서는 AI Chat으로 편집할 수 없습니다.
Markdown 문서 검색
title이나 body text로 Markdown 문서를 찾을 때는 global document search를 사용합니다.
- 상단 navigation에서 File > Search... 를 열거나
Ctrl+Shift+F/Cmd+Shift+F를 누릅니다. - Current project 또는 All workspace 를 선택합니다.
- 필요한 경우 type filter를 Markdown 으로 둡니다.
- query를 입력하고 결과를 선택해 문서를 엽니다.
검색 결과에는 document title과 content preview가 포함될 수 있습니다. Global search는 workspace 범위이며, ERD나 diagram 안의 canvas search와는 별도입니다.
MCP와 CLI 접근
Markdown 문서는 공개 document type markdown을 사용합니다.
MCP에서는 다음 tool을 사용합니다.
mcp__ai-erd__create_documents에서type: "markdown"으로 문서 생성mcp__ai-erd__update_documents로 title 또는 body 교체mcp__ai-erd__markdown_append_document로 내용 appendmcp__ai-erd__markdown_generate_document로 AI-ERD에 내용 생성 요청mcp__ai-erd__search_documents에서 필요한 경우type: "markdown"filter로 검색
본문이 큰 경우 purpose=document.create, document.update, document.append 중 하나로 upload token을 요청하고, chat prompt가 아니라 upload endpoint로 본문을 직접 전송하세요.
정확한 schema와 예시는 MCP Tool Reference를 확인하세요.