diff --git a/README.md b/README.md index 28a455a..047afa9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Hugging Face KREW Blog +## 커밋 가이드 + 1. 커밋 메시지 구조: [이모지] [간단한 설명] 2. 주요 이모지 및 의미: - ✨ (sparkles): 새로운 기능 추가 (Add) @@ -14,3 +16,19 @@ - 이모지는 커밋의 주요 목적을 나타내는 것을 선택합니다. - 설명은 간결하게 작성하고, 50자 이내로 제한합니다. - 복합적인 변경사항의 경우, 가장 중요한 변경 유형을 선택합니다. + +## 게시물 작성 가이드 + +1. 작성한 게시물에 작성자 정보를 표시해주세요. 블로그에 처음 글을 게시하는 작성자는 다음 내용을 참고해서 프로필을 작성해주세요. +- 프로필 썸네일로 사용할 이미지 파일을 `assets/images/author` 폴더 안에 추가합니다. +- `_config.yml` 파일의 "authors:" 항목 아래에 다음 형식으로 자신의 프로필을 작성합니다. + ``` + {작성자 이름}: + name: {전체 이름} + display_name: {표시될 이름} + avatar: 'assets/images/author/{프로필 썸네일 파일명.확장자}' + email: {이메일 주소} + web: {개인 웹사이트나 github 링크} + description: {자기소개 및 한마디} + ``` +- 마크다운 형식으로 작성한 게시물 파일 위쪽 구분선(—) 영역 사이에 `author: {작성자 이름}`을 추가하면 게시물에서 작성자 프로필이 표시됩니다. \ No newline at end of file