Git/GitHub: MarkDown 이해
오늘은 Git/GitHub에서 문서를 작성하고, 표현하는데 중요한 역할을 하는 'Markdown'에 대해 좀 더 자세히 알아보겠습니다. 'Markdown'은 간단한 구문으로 텍스트를 서식화하여 가독성을 높이는 동시에 HTML로 쉽게 변환할 수 있는 경량 마크업 언어입니다.
1. Git/GitHub Markdown이란?
GitHub에서 'Markdown'은 README 파일, 이슈, 풀 리퀘스트 등에서 사용되는 주요 문서 형식입니다.
Markdown은 HTML과 유사하지만 보다 간결하고 읽기 쉬운 구문을 제공합니다. 이는 일반적인 텍스트 형식으로 작성된 문서를 웹에서 바로 볼 수 있는 형태로 변환하는 역할을 합니다.
2. Markdown의 장점
Markdown의 주요 장점 중 하나는 그 단순함과 읽기 쉬움입니다.
복잡한 HTML 태그 없이도 깔끔하고 가독성 높은 문서를 만들 수 있습니다.
또한, Markdown으로 작성된 문서는 거의 모든 텍스트 에디터에서 열람 가능하며, GitHub와 같은 웹 기반 도구들과 호환이 잘 되어 손쉽게 웹 페이지로 게시할 수 있습니다.
3. Markdown 기본 구문
Markdown의 기본적인 구문은 다음과 같습니다:
1) 제목: '#' 기호를 사용하여 제목을 작성합니다.
# H1
## H2
### H3
#### H4
##### H5
###### H6
2) 목록: '*' 또는 '-' 기호를 사용하여 목록을 만듭니다.
* Item 1
* Item 2
* Sub Item 2a
* Sub Item 2b
3) 링크와 이미지: '링크 이름' 형식으로 링크를 만들고, ' ' 형식으로 이미지를 추가합니다.
4) 코드: '`'(backtick)을을 사용하여 인라인 코드를 작성하거나 '```'(triple backticks)로 여러 줄의 코드 블록을 생성합니다.
5) 볼드체와 이탤릭체: '*' 또는 '_' 기호로 감싸서 볼드체와 이탤릭체를 생성합니다.
4. GitHub Flavored Markdown(GFM)
GitHub에서는 기본적인 Markdown 외에도 몇 가지 추가적인 구문을 지원하는데, 이것을 GitHub Flavored Markdown(GFM)이라 합니다:
1) 체크박스 : '- [ ]' 와 '- [x]' 형태로 체크박스를 만들 수 있습니다.
2) 테이블 : '|'와와 '-' 를 이용하여 테이블을 생성할 수 있습니다.
| Header | Header |
| ------ | ------ |
| Cell | Cell |
3) 문법 강조 : '```'(triple backticks)와 함께 언어 이름을 명시하면 해당 언어의 문법에 따라 코드가 강조됩니다.
```python
print("Hello, World!")5. 마크다운 활용 팁
마크다운은 그 자체로도 매우 유용하지만, 조금 더 효과적으로 활용하려면 다음과 같은 팁들이 도움이 될 수 있습니다:
1) Preview 기능 활용: 대부분의 마크다운 에디터나 GitHub에서는 작성 중인 마크다운 문서의 미리 보기를 제공합니다. 이를 활용하면 작성 중인 문서가 실제로 어떻게 보일지 확인할 수 있습니다.
2) 이미지 추가: 이미지 파일을 깃헙 리포지토리에 업로드한 후 그 URL을 사용하여 README.md 파일 등에 이미지를 삽입할 수 있습니다.
3) 링크 사용: 관련된 다른 문서나 웹사이트를 참조해야 할 때는 링크 형식(`[text](url)`)을 사용하여 직접 연결하세요.
6. 결론
Markdown은 Git/GitHub에서 제공하는 중요한 도구 중 하나입니다. 간단한 구문으로 깔끔하고 가독성 있는 서식화된 텍스트를 만들어낼 수 있는 이 도구는 개발자뿐만 아니라 모든 분야에서 널리 활용되고 있습니다.
그러나 그저 단순한 구문일 뿐이라고 해서 대충 사용해선 안 됩니다. Markdown의 다양한 기능과 서식 옵션을 적절히 활용하여 정보를 명확하고 효과적으로 전달하는 것이 중요합니다. 이를 통해 협업 과정에서 효과적인 커뮤니케이션을 이룰 수 있으며, 프로젝트의 전반적인 진행을 더욱 원활하게 만들 수 있습니다.