Git & Github

[Git/GitHub] Issues, README.md, Markdown, Type프로그램

진기명기 2023. 2. 6. 03:21

 

* Git Issues / README / Markdown

 


* Issues (github에서 제공하는 issues 기능)

 

- 댓글 / label 등을 있음
- open / closed 기능을 통해 버그 해결 여부도 확인 가능
- 템플릿 생성 가능
  > 이슈에 대한 질문 등을 지정할 있음

 

 


* GIT README (github홈에서 사용 및 확인 가능)

 

* README.md란?
:
프로젝트가 어떤 목적으로 개발되었는지, 코드가 어떤 개요로 작성되었는지, 코드의 구조, 빌드 방법 프로젝트를 설명하는 문서

- markdown으로 작성된 문서

 

 

* Markdown이란?
: 일반 텍스트 형식의 문서의 양식을 편집하는 문법
: 특수기호와 문자를 활용한 간단 구조이기 때문에 쉽게 HTML 변환 가능하며, 빠르게 작성하고 읽을 있음

- gitbhub, wordpress, stackoverflow 등에서 사용
- Markdown 태그의 종류 (예시로 2~3개 정도)
  - 제목 : #,===== (실제로 html 변환해서 보여줄 때는 h1~h6등의 태그로 보여줌)
  - 인용 : >
  - 강조 : * , _ 등

- github > issues > template 생성시에도 Markdown 문법으로 작성 가능
  - write : markdown 문법으로 작성(한 화면을)
  - preview : html 기준으로 보여줌

 

 

* Type 프로그램

: 마크다운 리더 에디터

- html -> markdown으로 변경 / 반대도 가능