DevOps 도구/Git

Markdown 글쓰기 방법

눈곱만큼도모름 2025. 1. 12. 13:39
728x90
반응형

 

Markdown은 간단하고 직관적인 문법으로 텍스트를 서식화할 수 있는 경량 마크업 언어입니다.
이를 통해 별도의 복잡한 태그나 툴 없이도 간단하게 문서의 구조를 정의하고 가독성을 높일 수 있습니다.

Jupyter Notebook에서는 Markdown 셀을 활용하여 코드와 함께 주석, 설명, 수식, 링크 등을 추가할 수 있습니다.
특히 데이터 분석이나 머신러닝 작업 시 결과와 과정을 효과적으로 문서화할 수 있어 협업과 발표 자료 준비에 유용합니다.

Markdown은 GitHub과 같은 버전 관리 시스템에서도 널리 사용되며, README 파일(.md)에 주로 활용됩니다.
README 파일은 프로젝트의 개요, 설치 방법, 사용법, 기여 가이드를 설명하는 데 사용되며, Markdown을 통해 깔끔하게 포맷팅할 수 있습니다.

그 외에도 GitHub Pages, Jekyll, Hugo, API 문서, 변경 로그(CHANGELOG.md), 기여 가이드(CONTRIBUTING.md),레젠테이션 도구(예: Reveal.js) 등에 활용됩니다.

Markdown의 장점

  • 가독성: 복잡한 태그 없이 간결한 문법으로 문서를 작성할 수 있습니다.
  • 범용성: 다양한 플랫폼과 툴에서 지원됩니다.
  • 확장성: HTML, PDF, LaTeX 등으로 변환이 가능합니다.
  • 협업 지원: Git과 같은 도구에서 쉽게 변경 사항을 추적할 수 있습니다.

 

Markdown 기본 문법

1. 제목 (Headers)

# 제목 1 (h1)
## 제목 2 (h2)
### 제목 3 (h3)
#### 제목 4 (h4)
##### 제목 5 (h5)
###### 제목 6 (h6)
    

렌더링 결과:

제목 1 (h1)

제목 2 (h2)

제목 3 (h3)

제목 4 (h4)

제목 5 (h5)
제목 6 (h6)

2. 텍스트 서식

  • 굵게: **텍스트** 또는 __텍스트__
  • 기울임: *텍스트* 또는 _텍스트_
  • 굵게+기울임: ***텍스트***
  • 취소선: ~~텍스트~~
**굵은 텍스트**
*기울임 텍스트*
~~취소선 텍스트~~
    

3. 글자에 색 입히기

<span style="color: red;">이 문장은 빨간색입니다.</span>
<span style="color: blue;">이 문장은 파란색입니다.</span>
<span style="color: green;">이 문장은 초록색입니다.</span>

<span style="color: #FF5733;">이 문장은 HEX 색상(#FF5733)입니다.</span>
<span style="color: rgb(255, 99, 71);">이 문장은 RGB 색상(rgb(255, 99, 71))입니다.</span>

4.빈칸 추가하기

가           나
#이렇게 쓰더라도 가 나 결과를 얻음

&nbsp; 를 사용

가&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;나

4. 리스트

- 순서 없는 리스트: -, *, +

- 순서 있는 리스트: 숫자와 점(1.)

- 항목 1
- 항목 2
  - 하위 항목 2.1
  - 하위 항목 2.2

1. 첫 번째
2. 두 번째
   1. 두 번째의 하위 1
   2. 두 번째의 하위 2
    

렌더링 결과:

  • 항목 1
  • 항목 2
    • 하위 항목 2.1
    • 하위 항목 2.2
  1. 첫 번째
  2. 두 번째
    1. 두 번째의 하위 1
    2. 두 번째의 하위 2

5. 링크

[링크 텍스트](https://example.com)
    

링크 텍스트

6. 이미지

![이미지 설명](이미지 URL)
    

이미지 설명

7. 코드 블록

  • 인라인 코드: `코드`
  • 블록 코드: ```로 감싸기
`인라인 코드`
    
```python
# 파이썬 코드 블록
print("Hello, World!")

8 인용문 (Blockquote)

> 인용문 예시
>> 중첩된 인용문

 

9. 수식 (LaTeX)

Jupyter Notebook에서 LaTeX 문법을 지원합니다.

  • 인라인 수식: $수식$
  • 블록 수식: $$수식$$
인라인: $E = mc^2$

블록:
$$
E = mc^2
$$

10. 표만들기

| 언어        | 정수 타입          | 크기 제한                     | 메모리 사용       |
|-------------|--------------------|-------------------------------|-------------------|
| **Python**  | `int`              | 무제한 (메모리 한계)          | 값에 따라 가변적  |
| **C/C++**   | `int`, `long`      | 고정 크기 (32/64비트)          | 고정적            |
| **Java**    | `int`, `long`      | 고정 크기 (32/64비트)          | 고정적            |
| **R**       | `integer`, `double`| 고정 크기 (32비트 정수, 64비트 부동소수점) | 고정적            |

Markdown 활용 예시

# 프로젝트 개요

## 주요 기능
1. 데이터 수집
2. 데이터 분석
3. 시각화

### 코드 예시
```python
print("Hello Markdown!")

 

728x90
반응형

'DevOps 도구 > Git' 카테고리의 다른 글

깃허브 repository 만들때 나오는 라이센스 선택 설명  (0) 2025.01.09
[Git] 명령어 정리  (0) 2024.05.03