GitHub - README, 마크다운 문법 알아보기

README란?

README는 쉽게 말해서 프로젝트 소개글이라고 할 수 있습니다. 일반적으로 디렉토리나 압축 파일에 포함된 기타 파일에 대한 정보를 포함하고 있으며, 일반적으로 소프트웨어와 함께 배포됩니다. 또한 현재 Git과 같은 코드 저장소에서도 해당 파일을 기본값으로 생성되게 하여 해당 저장소에 대한 설명을 기입하도록 유도하고 있습니다. 다른 확장자를 사용할 수도 있겠으나 기본적인 README의 확장자는 md인데 이것은 마크다운(Markdown)의 약자입니다.

 

⭐️ 마크다운 사용법

---

1. 제목, 부제목 설정

• #을 사용하여 설정합니다.

html h1 ~h6 태그와 같아서 참 쉽네요!

 

2. 밑줄 설정

• -, *, _ 맘에 드는 키를 골라 3번 반복해 줍니다.

3가지 중 맘에 드시는거 골라 씁니다.

 

3.리스트

• +, -, * 중 맘에 드는 키를 사용하며 목록 안 목록은 tab 키를 누르고 사용해 줍니다.
• 숫자 리스트는 1,2,3 누르면 됩니다.

이 역시 3개 중 맘에 드는 걸로 씁니다.

번호만 입력하면 됩니다.

 

4. 글씨체 bold(강조), italic(기울임), strikethrough(취소선) 

• 강조는 **글씨**
• 기울임체는 *글씨*
• 취소선은 ~~글씨~~

유용하게 쓰이는 문법입니다.

 

5. 인용문(Quote)

• > 키를 이용해 사용해줍니다. 여러 문법과 같이 쓸 수 있습니다.

다른 문법과 조화롭게 쓰면 보기 좋아집니다.

 

6. 클릭 가능한 링크

• 대괄호 [클릭한 글자](접속될 링크)

참고 사이트를 연결해 줄 때 유용합니다.

 

7. 이미지

•       --> 사진 크기 수정 불가능
• <img src="사진 링크" width="사이즈" height="사이즈"/>      --> 사진 크기 수정 가능
• 사진은 리포지토리 Issues에 이미지를 드래그앤드롭하면 사진이 링크형식으로 변하는데 그걸 복사 붙여넣기로 넣으면 편합니다.

편리하게 링크를 가져올 수 있습니다.

 

8. 테이블

• |글자|글자|       -> 테이블 내용의 주제 
• |:--:|:--:|          -> 구분선
• |내용|내용|        -> 내용

알아두면 좋습니다..!

 

9. 코드

• 백틱 ```을 사용해줍니다 . 첫 줄 ``` 옆에 원하는 언어를 적으면 그에 맞게 코드가 변화됩니다.

강조할 코드를 작성할 때 좋습니다.

 

10. 체크 리스트

• 체크리스트는 vscode에서 편집할 수는 없고 깃허브에서만 가능합니다.
• 무엇을 해야하는지 적어놓으면 일정관리가 한층 쉬워집니다.
• - [ ] : 해야할 작업
• - [x] : 마친 작업