README 마크다운 미리보기 및 브라우저 우선 편집
브라우저 우선 Markdown 작업 영역이 페이지를 떠나지 않고 README 스타일 콘텐츠의 초안을 작성하고, 미리 보고, 공유하는 가장 빠른 방법인 경우 이 가이드를 사용하세요.
에디터는 실시간 미리보기, 분할 보기, 프리셋을 제공합니다. 초안 작성용 도구이며 저장소 히스토리나 리뷰를 대체하지 않습니다.
이럴 때 사용하세요
실시간 미리보기가 포함되고 필수 편집기 설치가 없는 빠른 README, 릴리스 노트 또는 런북 초안이 필요합니다.
가장 먼저 점검해야 할 사항
마크다운 자체가 문제라고 가정하기 전에 보기 모드, 렌더링 미리보기, 상태 공유를 함께 확인하세요.
가드레일
초안은 이 기기의 브라우저 저장소에 남습니다. 사이트 데이터를 지우면 사라지며, 공유 링크를 복사하기 전까지는 URL에 아무것도 들어가지 않습니다.
README 개요
최종 세부 사항을 작성하기 전에 제목 구조가 필요한 경우 README 사전 설정부터 시작하세요.
# Project Overview
## Install
## Usage
릴리스 노트
독자가 빠르게 스캔할 수 있도록 작업 형식이 명확하게 변경되는 경우 릴리스 노트 초안을 사용하세요.
# Release Notes
- Added safer share handling
- Fixed layout regressions
사고 대응 런북
마크다운이 마케팅 카피 대신 운영 지침이 될 경우 런북 패턴으로 전환하세요.
## Triage
1. Confirm impact
2. Capture rollback window
3. Share updates
Markdown 편집기는 더 무거운 작성 스택으로 이동하지 않고도 빠른 초안, 실시간 미리 보기 및 제어된 공유 동작이 필요할 때 가장 강력합니다.
- 분할 보기를 먼저 사용하면 소스와 렌더링된 출력이 함께 표시됩니다.
- 로컬 초안 저장소와 명시적 공유 URL을 별도의 워크플로로 처리합니다.
사전 설정된 링크는 광범위하게 공유해도 안전하지만 명시적인 초안 URL은 정확한 Markdown 본문을 이동해야 하는 경우에만 복사해야 합니다.
- URL에 비해 초안이 너무 큰 경우 공유 상태로 강제 전환하는 대신 로컬 브라우저 워크플로를 계속 사용하세요.
- 검토 범위가 하나의 활성 초안을 미리 보는 것이 아니라 두 문서 개정판을 비교하는 경우 diff를 사용하십시오.