From f30ea341d4c65690c37c1a52eee02e778e79e4cf Mon Sep 17 00:00:00 2001 From: Jaehyeon1020 Date: Sun, 12 Nov 2023 19:34:38 +0900 Subject: [PATCH] =?UTF-8?q?feat:=20=EB=A6=AC=EB=93=9C=EB=AF=B8=20=EB=82=B4?= =?UTF-8?q?=EC=9A=A9=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 60 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 061b1c7..db8aed3 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,71 @@ ## How to use -[Hugo](https://gohugo.io/installation/)를 먼저 설치해주세요. +- 먼저 [hugo](https://gohugo.io/installation/)를 설치해주세요. -아래 명령어를 입력하면 Hugo 서버가 실행됩니다. +## 글 작성하기 +- 다음 명령어로 `index.md`를 생성하고 여기에 마크다운으로 글을 작성할 수 있어요. + +```bash +hugo new [디렉토리 이름]/index.md # 디렉토리 이름은 글 주제와 연관되는 것으로 마음대로! ``` -hugo server + +- 생성한 `index.md`에 다음 내용이 들어있어요. + +```markdown +--- +title: "Test" +date: 2023-11-10T16:52:29+09:00 +draft: true +--- +``` + +- `draft` 옵션이 켜져있는 경우 블로그를 빌드했을 때 작성한 글이 보이지 않으니 지워주세요. +- `author`, `description`, `tags`을 다음과 같이 추가해주세요. +- `title`을 수정해 글 제목을 변경할 수 있어요. + +```markdown +--- +title: "Test" +date: 2023-11-10T16:52:29+09:00 +author: "작성자" +description: "블로그 글을 써봅시다" +tags: ["HUGO"] +--- + +## 팀 블로그에 글을 써봅시다 + +여기에 이렇게 글을 작성해 주세요 ``` -Draft까지 포함해서 보고 싶다면 `-D` 옵션을 추가해주세요. +- 사진을 삽입할 수 있어요. +- 원하는 사진을 index.md와 같은 디렉토리로 복사하고 다음처럼 작성해주세요. +```markdown +![대체 텍스트](이미지 경로) +![챗지피티](ChatGPT.webp) ``` -hugo server -D + +- 유튜브 영상을 삽입할 수 있어요. +- VIDEO_ID는 https://www.youtube.com/watch?v=abcdef 이것과 같은 유튜브 영상 url에서 `v=`뒤에 위치하는 문자열이에요. + +```markdown +{{< youtube VIDEO_ID >}} +``` + + + +## 작성한 글 보기 + +- 아래 명령어로 Hugo 서버를 실행할 수 있어요. +- 정상적으로 실행되면 어느 포트에서 실행중인지 터미널을 통해 출력돼요. +- draft를 포함해 보고싶다면 -D 옵션을 추가해주세요. + +```markdown +hugo server +hugo -D server ```