[리액트 React] 깃허브 리드미 작성 (Github_ReadMe)

ReadMe

프로젝트에 대한 간단 설명을 담은 문서 마크다운으로 작성한다

 

마크다운

태그 등을 이용하여 문서나 데이터의 구조 등을 명기하는 언어의 한 가지로 텍스트 문서들을 작성할 때 자주 사용되며, 다른 마크업 언어들에 비해 문법이 쉽고 간단한 것이 특징이다. HTML 등의 서식 문서들로 쉽게 변환되기 때문에 README 파일이나 온라인 게시물 등에 사용된다.

 장점
1. 간결하다.
2. 별도의 도구없이 작성가능하다.
3. 다양한 형태로 변환이 가능하다.
4. 텍스트(Text)로 저장되기 때문에 용량이 적어 보관이 용이하다.
5. 텍스트파일이기 때문에 버전관리시스템을 이용하여 변경이력을 관리할 수 있다.6. 지원하는 프로그램과 플랫폼이 다양하다.

단점
1. 표준이 없다.
2. 표준이 없기 때문에 도구에 따라서 변환방식이나 생성물이 다르다.
3. 모든 HTML 마크업을 대신하지 못한다.

 

리드미 작성법

• 머릿글
• 목록
• 코드 블럭
• 수평선
• 이미지
• 글 강조
• 테이블

---

머릿글

• h1 ~ h6
• # 한 칸 띄우고 작성해 줘야하고, #, ## 은 아래 선이 삽입된다

 

# This is a H1
## This is a H2
### This is a H3
#### This is a H4
##### This is a H5
###### This is a H6

 

 

 

 

 

 

---

목록

• 순서있는 목록(번호)

1. 첫번째

2. 두번째

3. 세번째

 

• 순서없는 목록

글머리 기호: *, +, -

* 빨강
  * 녹색
    * 파랑

+ 빨강
  + 녹색
    + 파랑

- 빨강
  - 녹색

                                           - 파랑

---

코드 블럭

 

```

코드

```

---

수평선

--- 

 

 

---

이미지

1. 깃헙 리포지토리 이슈
2. New issue
3. Write 부분에 이미지 드래그하면 URL로 변환되고 그걸 복사해서 사용하면 된다.

 

• 이미지 사이즈를 조절하여 등록

<img src ="https://github.com/cheolgyun7/deve11og/assets/134026105/1faca00b-2c3a-4552-858a-a7751ff2b8c5" width="50%">

 

• 사이즈 조절 없이 등록


---

글 강조

 

** 내용 ** 

 

---

테이블 만들기

 

가운데 정렬하는 방법

|---| 이 안에 : : 를 넣어주면 된다

 

|제목|제목|제목|제목|

|:---:|:---:|:---:|:---:|

|내용|내용|내용|내용|