본문 바로가기

GitHub

깃허브(GitHub) 리드미(README) 작성법/꾸미기/마크다운/이모지

1.  마크다운(MarkDown)

Markdown은 일반 텍스트 기반의 경량 마크업언어로 2004년 존그루버에 의해 만들어졌으며 쉽게 쓰고 읽을 수 있으며 HTML로 변환가능하다. 일반 텍스트로 서식이 있는 문서를 작성하는데 사용되며, 일반 마크업 언어에 비해 문법이 쉽고 간단하다.

 

특수기호와 문자를 이용한 매우 간단한 구조의 문법을 사용하여 웹에서도 보다 빠르게 컨텐츠를 작성하고 보다 직관적으로 인식할 수 있다.

 

GitHub 저장소Repository에 관한 정보를 기록하는 README.md를 마크다운 언어로 작성한다.

 

2. 기본 문법

https://gist.github.com/ihoneymon/652be052a0727ad59601

 

마크다운(Markdown) 사용법

마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.

gist.github.com

 

3 . README(리드미) 꾸미기

1) 뱃지

https://k-sky.tistory.com/73

 

README(리드미) 꾸미기-뱃지

1. 심플 아이콘을 이용하여 기술 스택/Tools 뱃지 넣기 https://simpleicons.org/ Simple Icons 2339 Free SVG icons for popular brands. simpleicons.org // 스프링부트 로고 뱃지 만들기 예시 뱃지이름: 뱃지..

k-sky.tistory.com

2) 이모지

https://www.webfx.com/tools/emoji-cheat-sheet/

 

Emoji Cheat Sheet

Emoji codes used by GitHub, Basecamp, Slack and other services. Searchable. With emoji meanings.

www.webfx.com

 

3) 이미지 올리기(깃허브 이슈를 이용한 이미지 올리기! 이슈 작성X)

https://k-sky.tistory.com/74

 

README(리드미) 꾸미기-이미지 올리기

1. 깃허브 이슈를 이용한 이미지 올리기 (이슈를 이용하지만 이슈가 작성되는 것은 아님) 1) repository -> Issues 탭 -> New issue 2) 리드미에 넣을 이미지를 드래그 앤 드롭 3) 주소 복사해서 리드미 파일

k-sky.tistory.com

 

4) (유튜브)동영상 올리기

https://bitlog.tistory.com/101

 

마크다운에 유투브 링크 넣기.

README 문서를 만들때, 요새는 마크다운을 많이 사용하는 것 같습니다. 아마 코드 저장소로 GitHub을 많이 들 사용하기 때문일 것 같습니다. 그리고 마크 다운이 문법이 복잡하지 않고, 텍스트 에디

bitlog.tistory.com

[![이미지 텍스트](스크린샷 이미지)](유투브링크)
[![](http://img.youtube.com/vi/{유튜브주소id}/0.jpg)](https://www.youtube.com/유튜브주소id ))

https://velog.io/@sgsg9447/Github-Readme%EC%97%90-img-youtube-link-%EC%82%BD%EC%9E%85

 

Github - Readme에 img, youtube link 삽입

이미지 삽입 후, 변환된 주소 사용!\[!\[이미지 텍스트](스크린샷 이미지)](유투브링크)\[!\[Video Label](http://img.youtube.com/vi/'유튜브주소의id'/0.jpg)](https://youtu.be/'유튜브주소의id

velog.io

 

 

 

 

나중에 추가로 해보기

https://velog.io/@seondal/Github-Readme-%EA%BE%B8%EB%AF%B8%EA%B8%B0-%EC%B4%9D%EC%A0%95%EB%A6%AC

 

Github Readme 꾸미기 총정리

내 깃허브의 얼굴이자 포트폴리오인 깃허브 리드미 프로필을 다양한 뱃지와 위젯을 이용하여 돋보이게 꾸며봅시다 ..

velog.io

https://yoon990.tistory.com/38

 

[Github] ReadMe 리드미 꾸미기 (및 매우 소소한 팁들)

그동안 하고 싶었던 깃허브 리드미를 드디어 간단하게 꾸며봤다. 나도 여러개의 블로그를 보면서 꾸민거라서 수정할 때 언제든지 볼 수 있도록 정리하려고 한다. 우선 리드미를 꾸미기 전에 가

yoon990.tistory.com

https://hawaiian-pizza-it.tistory.com/18

 

[GitHub] 깃허브에 gif 파일 업로드 (맥북)

프로필 README를 작성하면서 gif를 하나 올렸었는데 다시 쓰려니까 금방 잊어서 기록해두려고 한다. 리드미에 그냥 올리면 되는 줄 알았는데 아니라서 귀찮다. 그러니 기록하자. repository에 있는 REA

hawaiian-pizza-it.tistory.com

 

 

 

--

약간.. 글 좀 정리해야겠다..

그리고 사용하면서 추가할거 추가하기~!