삽질 피하기
[삽질 피하기] 자주 사용하는 README.md
ozofweird
2021. 3. 31. 15:56
1. 자주 사용하는 README.md
1) IntelliJ
IntelliJ로 Spring Initializer로 생성할 경우, 기본적으로 HELP.md 파일이 생성된다. 되도록 HELP.md를 README.md로 이름을 바꿔주고 활용하는 습관을 들이도록 해야한다.
2) 제목, 부제목
# 제목
## 제목
### 제목
#### 제목
3) 코드 블록
```shell script
$ sudo ./gradlew build
$ sudo java -jar server.jar
```
4) 글씨
*기울임*
**굵은 글씨**
~~취소선~~
5) 인용구
> 인용구 1
> > 인용구 2
> > > 인용구 3
6) 글 머리 기호
+ 목록 1
+ 목록 2
* 목록 1
* 목록 2
- 목록 1
- 목록 2
7) 구분선, 수평선
---
***
___
8) 하이퍼 링크, 이미지 첨부
[test](./docs/test.md)
![test](./images/test.png)
9) 표
|제목|내용|설명|
|---|---|---|
|aaa|bbb|ccc|
|ddd|eee|fff|
|정렬1|정렬2|:정렬3|
|:---|---:|:---:|
|왼쪽|오른쪽|중앙|
|왼쪽|오른쪽|중앙|
728x90