[Git Hub] README.md 작성법

✅ 깃허브(GitHub)에 README.md 파일 생성하기

자신의 레포지토리(repository)에 README.md를 추가하지 않았다면, Add a README를 클릭하여 추가할 수 있다.

---

✅ 마크다운 문법(MarkDown) 작성 법

마크다운(MarkDown)은 사용이 쉽고, 마크업 언어인 HTML 태그에 비해 간단하기 때문에 문서 작성이 편리하다.
(하지만, 마크다운을 지원하는 프로그램이나 사이트에서만 사용 가능)

---

✅ 마크다운 문법

• 헤더 (Header)

  텍스트 앞에 #을 붙인다. 단, #과 텍스트 사이에 한 칸을 띄워야 한다.
  #을 1개부터 6개까지 개수를 조절하면 위의 화면처럼 헤더 글자의 크기를 키울 수 있다.

• 줄 바꾸기 (LF, Line Feed)

  엔터(Enter)를 2번 눌러서 빈 줄(Blank)을 추가하면 한다.

• 인덱싱 (Indexing)

  순서를 매기는 것 평소의 방법과 동일하지만, 들여쓰기는 불가능하다.

• 구분선 (Division Line)

  -와 *모두 사용이 가능하고 3개 이상을 사용하면 된다.
  이글의 구분선들도 똑같이 생성 했다.

• 코드블럭

  첫번째, 코드 앞부분에 4칸을 띄워주고, 위아래로 한 줄씩 띄워줘서 사용한다.
  안 띄어주면 적용이 안 된다.
  두번째, 블록 위아래로 ```을 써주는 방법이 있다.

  	const name = 'README'

• 하이퍼링크 (Hyperlink)

  <>안에 주소를 작성한다. https://velog.io/
  []<=링크이름 ()<=링크주소를 넣으면 이것처럼 링크를 걸 수도 있다.

• details태그 (접고 펼치기)

  깃 허브 위키(Wike) 혹은 README.md(리드미) 파일 혹은 글을 보았을 때 클리하면 글이 펴지고 다시 클릭하면 글이 접히게 하는 기능

  <details>
    <summary>접기 / 펼치기</summary>
    이곳에 접은 내용 적기
  </details>

• 체크박스 (Check Box)

  -, *, + 뒤에 띄어쓰기 후 대괄호를 넣어서 작성한다.
  대괄호 안에 띄어쓰기를 하면 빈 체크박스, x를 넣으면 체크된 체크박스가 생긴다.

  • 체크박스
    ex) - [ ]
  • 체크박스(x)
    ex) - [x]

• 이모지 👌

  window10: 윈도우 키 + 마침표(.)
  mac: Command + Control + 스페이스 바

---

✅ 다른 사람 README.md 소스 복사하기

다른 사람의 repository에서 위에 체크된 README.md를 클릭하면 하단의 화면이 나올 것이다.
Code를 누르면 그 사람의 MarkDown 소스가 보일 것 이다.
더 자세한 마크 다운 문법(클릭)

---

• 참고 자료
  무작정 개발
  yuuuye