Notice
Recent Posts
Recent Comments
Link
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | ||||||
2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 31 |
Tags
- Elastic Search
- 자바스크립트
- 깃허브
- 네이버커넥트재단
- 코드프레소
- codepresso
- 무료코딩교육
- 코딩이러닝
- 코딩강의
- AI코칭스터디
- 슥삭
- reduce()
- 코딩스터디
- 코딩테스트
- 리액트
- 타입스크립트
- 마크다운
- API 명세서
- markdown
- 엘라스틱서치
- IT교육
- 프로그래머스
- 대외활동
- GitLab
- git
- NCP
- 네이버클라우드플랫폼
- 무료IT교육
- 매직메서드
- MySQL
Archives
- Today
- Total
개발하는 무민
Markdown 기본 문법 정리_깃허브 활용 본문
깃허브를 사용할때 프로젝트에 대한 설명 문서를 Markdown으로 작성하기 위해 기본적인 문법을 정리한다.
<!--헤딩-->
# H1 테스트 문장
## H2 테스트 문장
### H3 테스트 문장
#### H4 테스트 문장
##### H5 테스트 문장
###### H6 테스트 문장
<br>
<br>
일반 텍스트 문장입력시 이렇게 표시됩니다.
<br>
<br>
<!-- 라인 추가시 -->
___
언더바 세번 입력시 라인이 추가됩니다.
<br>
<br>
원하는 단어를 별 두개로 감싸면 **볼드체**, 하나만 감싸면 *이탈릭체*
물결 모양으로 감싸면 ~~선긋기~~
<br>
<br>
<!-- quote -->
원하는 문장을 인용구 안으로 넣기
> Don't forget to code your dream.
<br>
<br>
<!-- bullet list-->
별 모양을 앞에 하나만 달아준다면 목록으로 변환 가능
* 룰루
* 랄라
- 대쉬를 이용해도
- 목록을 만들 수 있다.
1. 숫자를 붙여도
2. 만들 수 있다.
<br>
<br>
<!-- 링크 -->
클릭이 가능한 링크 만들기
대괄호 안에 원하는 문장을 넣고, 소괄호 안에 링크를 작성해준다.<br>
[네이버 바로가기!](https://www.naver.com/)
<br>
<br>
<!-- 이미지 -->
느낌표 [대괄호 안에 이미지에 대한 설명 작성](소괄호 안에 이미지의 링크 첨부)<br>
<br>
이미지의 링크는 '오른쪽클릭-이미지주소복사'로 얻을 수 있다.<br>
PC에 저장된 이미지를 추가하고 싶다면 파일을 드래그 드롭하여 추가할 수 있다.<br>
이미지의 크기를 일괄적으로 조정하고 싶다면 html의 이미지 태그 <img src=블라블라> 태그를 사용하여 조정해 줄 수도 있다.
<br>
<br>
<!-- 테이블-->
짝대기를 쓰고 헤더 이름을 적어 작성 한뒤 작대기를 닫으면 한 셀이 작성이 된다.<br>
여러개를 이어붙이고 싶다면 작대기를 열고 닫으면서 반복하면 됨.<br>
선을 그어서 행을 완성시키고 싶다면 '작대기 -- 작대기 -- 작대기'<br>
|헤더|디스크립션|
|--|--|
|셀1|셀2|
|셀1|셀2|
|셀1|셀2|
<br>
<br>
셀들을 정렬해주고 싶다면 -- 다음에 : 콜론을 오른쪽에 붙여주면 오른족 정렬, 왼쪽에 붙여주면 왼쪽 정렬이 된다.<br>
중간으로 정렬하고 싶다면 양쪽에 콜론을 붙여준다.<br>
|헤더|디스크립션|
|--:|--:|
|셀1|셀2|
|셀1|셀2|
|셀1|셀2|
|헤더|디스크립션|
|:--|:--|
|셀1|셀2|
|셀1|셀2|
|셀1|셀2|
|헤더|디스크립션|
|:--:|:--:|
|셀1|셀2|
|셀1|셀2|
|셀1|셀2|
<br>
<br>
<!--code-->
문서 안에서 특정한 코드를 보여주고 싶은 경우<br>
###### `(백틱)키를 이용해서 코드를 감싸주면 인라인 형태로 표시된다.
`print("Hello World!")`
다수의 코드가 있는 경우엔 백틱 키를 세번 누르고 작성하면 코드 블럭이 만들어진다.
``` console.log('your message')
console.log('your message')
console.log('your message')
```
해당 언어가 어떤 것인지 백틱 키 뒤에 적어준다면 색도 적용됨.
```js
console.log('your message')
console.log('your message')
console.log('your message')
```
```py
print("Hello World!")
print("Hello World!")
```
코드에 대한 프리뷰는 아래와 같다.
해당 코드는 깃허브에 업로드해둠.
https://github.com/wndnjs2037/2020_systemprogramming/edit/master/markdown_test.md
'Development' 카테고리의 다른 글
[JWT/보안] JWT token을 사용하는 이유 (0) | 2023.05.10 |
---|---|
[API] API 문서 작성 요령 익히기 (0) | 2022.12.16 |