README.md란?
: 프로젝트을 설명하는 문서
- 어떠한 목적으로 개발되었는지, 코드의 개요, 코드의 구조, 빌드 방법, 사용법등을 마크다운으로 작성한다.
README
- Markdown 에디터
Typora : 유료 마크다운 리더 & 에디타
마크다운언어로 변경해주는 사이
Typora — simple yet powerful Markdown reader.
Readable & Writable Typora gives you a seamless experience as both a reader and a writer. It removes the preview window, mode switcher, syntax symbols of markdown source code, and all other unnecessary distractions. Instead, it provides a real live preview
typora.io
Martdown란?
- 일반 텍스트 형식의 문서의 양식을 편집하는 문법
- 누구나 쉽게 읽고 쓸수 있으면 HTML로 변환이 가능하다.
- 특수 기호롸 문자를 이용한 매우 간단한 구조의 문법을 사용해 빠르게 작성하고 쉽게 읽을 수 있다.
Martdown 태그 종류
- 제목 : $, ====
- 인용 : >
- 강조: * , _
- 링크 : [텍스트](주소 "설명 생략가능")
- 이미지 : 
- 리스트 : 1, * , - , +
- 코드표시 : <code>코드</code>, 한줄 띄우고 스페이스 4칸, '''코드'''
- 줄바꿈 : 엔터 2번, 강제 줄바꿈은 문장 끝에 스페이스바 2칸
- 가로선 : -----, ***** , +++++
유용한 사이트
Markdown Guide
A free and open-source reference guide that explains how to use Markdown.
www.markdownguide.org
실습화면
'Git,GitHub' 카테고리의 다른 글
| [Git, GitHub] ISSUES 템블릿 생성하기 (0) | 2025.01.14 |
|---|---|
| [Git, GitHub] Pull Request 알아보기 (0) | 2025.01.13 |
| [Git, GitHub] Fork 알아보자! (0) | 2025.01.13 |
| [Git, GitHub] sourcetree로 Conflict 해결하기 (0) | 2025.01.13 |
| [Git, GitHub] sourcetree로 Merge 해보기 (0) | 2025.01.13 |