Word to GitHub Markdown: GitHub READMEs 및 문제들을 위한 문서 형식

GitHub는 Markdown라는 방언을 사용합니다. GitHub 맛있는 Markdown (GFM). It’s mostly standard Markdown with a few extras — fenced code blocks with syntax highlighting, task lists, tables, and automatic link detection. If you’re converting a Word document into a GitHub README or wiki page, here’s what you need to know.

GitHub 맛이 있는 Markdown는 무엇입니까?

GFM은 GitHub의 확장자입니다. Word에서 변환할 때 가장 중요한 덧셈은 다음과 같습니다:

울타리 된 코드 블록 언어 식별자 (```python)
표 파이프 문법을 사용함
작업 목록 using - [ ] and - [x]
스트라이크 using ~~text~~
자동 링크 텅 빈 URL을 클릭할 수 있게 됩니다.

Word 문서를 Word에서 변환 WordToMD 그러면 GFM 호환된 출력을 기본으로 얻을 수 있습니다.

Word 스타일 → GFM 요소

Word 요소	GFM 출력
부문 1	`# H1`
부문 2	`## H2`
대담한	`bold`
구사문	`italic`
표	파이프 테이블
표지판 목록	`- item`
번호가 표시된 목록	`1. item`
하이퍼링크	`[text](url)`
모노스페이스 글꼴	`code`
스트라이크	`~~text~~`

GitHub- 변환 후 추가할 특정 기능

작업 목록

Word에는 네이티브 작업 목록 요소가 없습니다. Word doc에 체크박스가 있다면, 그것들은 일반 텍스트로 변환됩니다. 변환 후 GFM 작업 목록으로 포맷:

- [x] Completed item
- [ ] Pending item
- [ ] Another pending item

이들은 GitHub 이슈, Pull Request, 프로젝트 README 파일에서 인터랙티브 체크박스로 렌더링됩니다.

문법 하이라이트를 가진 울타리 코드 블록

Word에서 모노스페이스 텍스트를 인라인 코드로 변환합니다. GitHub에서 여러 줄의 코드 블록을 위해, 언어 식별자를 가진 울타리 문법을 사용한다:

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}


GitHub supports dozens of languages. See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide) for the full language list and syntax rules.

### Alerts (GitHub-Specific Callouts)

GitHub renders special blockquote syntax as colored callout boxes:

```markdown
> [!NOTE]
> This is a note callout.

> [!WARNING]
> This is a warning.

> [!TIP]
> This is a helpful tip.

워드 문서에 호출 상자 또는 강조한 메모가 있다면, 초기 변환 후에 이 GFM 알림 문법으로 변환합니다.

Word 문서에서 README를 구성

전형적인 소프트웨어 README는 다음과 같은 구조를 따르고 있습니다.

# Project Name

Short description.

## Installation

## Usage

## Configuration

## Contributing

## License

만약 Word 문서가 프로젝트 사양 또는 문서 초안이라면, 그 섹션들을 README 헤딩으로 매핑합니다. 사용 WordToMD 원료를 변환하고 GitHub에 특유한 요소를 재조직하여 추가합니다.

GitHub Markdown의 테이블

Word 테이블은 직접 GFM 파이프 테이블로 변환합니다. 변환된 테이블은 다음과 같습니다.

| Feature | Status | Notes |
|---|---|---|
| Authentication | ✅ Done | JWT-based |
| File upload | 🚧 In progress | S3 target |
| API docs | ❌ Pending | — |

GitHub는 또한 열 정렬을 지원합니다:

| Left | Center | Right |
|:---|:---:|---:|
| text | text | text |

Markdown 테이블에 대한 모든 내용은 참조 Markdown 표: 완전한 안내.

GitHub 저장소에서 이미지

GitHub는 리포의 상대 경로에서 이미지를 렌더링합니다:

![Architecture diagram](docs/images/architecture.png)

Word 문서에 지원된 그림이 있다면, Markdown + 이미지 ZIP, 패키지된 이미지 파일을 docs/images/, 그리고 저장소가 다른 폴더 구조를 사용하는 경우 상대적인 경로를 업데이트합니다.

GitHub.com로 호스팅된 이미지에서는 절대 URL을 사용할 수도 있습니다.

![Screenshot](https://github.com/user/repo/raw/main/screenshot.png)

GitHub 위키 페이지

GitHub 위키는 GFM 스펙을 지원합니다. 변환 워크플로우는 README와 동일합니다.

Word 문서를 WordToMD
GFM-특정 포맷을 추가 (업무 목록, 코드 울타리, 알림)
새 위키 페이지를 만들고 Markdown를 붙여넣습니다.

헤드 ID 및 앵커 링크

GitHub는 제목 텍스트에서 앵커 ID를 자동 생성합니다. 부문 ## Installation ID를 얻습니다. #installation. You can link to it from elsewhere in the same document:

See the [Installation section](#installation) below.

이것은 내용 표를 가진 긴 README에 유용합니다. 변환 후, 상단에 TOC를 추가합니다.

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)

FAQ

GitHub는 Markdown에서 HTML을 표시합니까? GitHub는 Markdown에서 일부 HTML 태그를 허용하지만 대부분의 스타일링 속성을 제거합니다. 최적의 결과를 위해 Markdown 문법을 따르십시오.

제 테이블에는 열이 너무 많고 모바일에서 좁아 보입니다. 어떻게 해야 할까요? 큰 테이블을 더 작은 테이블로 나누거나 HTML를 사용하십시오. <details> 접이 가능한 부분의 표지판.

Word를 사용하여 GitHub 문제를 쓸 수 있나요? 그래요! Word doc를 Markdown로 변환 WordToMD 그리고 출력을 GitHub 이슈 또는 Pull Request 설명에 직접 붙여넣습니다.

전체 Word 문서 세트를 GitHub 위키로 변환하는 방법은 무엇입니까? 각 Word 파일을 개별적으로 변환하고 문서당 하나의 위키 페이지를 생성합니다. 본문 배치 변환 Word to Markdown Pandoc로 스크립트를 작성한 것에 대한 것입니다.

결론

Word로 변환 GitHub Markdown 간단합니다 사용 WordToMD 기본 Markdown를 얻으려면, 작업 목록, 코드 울타리 및 호출 알림과 같은 GFM에 대한 특정 기능을 층화하십시오. Word 문서의 깔끔한 구조로 (내장된 헤드 스타일, 적절한 테이블) 변환 출력은 거의 GitHub로 밀릴 준비가 될 것입니다.