README.md

직접 만들어본 Gatsby blog

Home Page · Request Feature

🙌 소개

제가 어떤 생각을 가지고 개발하고 있는지 나타내기 위해 블로그를 개발하게 되었습니다. 이전부터 TIL에 학습 내용을 정리하고 있었는데, TIL은 산재 되어 있는 지식을 저 만의 방식으로 정리하려는 목적으로 운영하며 저 만의 인사이트를 담은 개발 블로그와는 구분되어야 한다고 생각합니다.

개발 블로그를 위한 여러 플랫폼과 완성된 stater 패키지가 존재하지만 직접 개발하기로 결심했습니다. 직접 개발 블로그를 운영하는 과정에서 배포 이후 필요한 부분을 경험할 수 있고, 개발 과정에서 미쳐 확인하지 못한 부분을 확인할 수 있지 않을까 기대했습니다. 또한, 직접 설계하고 원하는 기능을 자유롭게 추가하며 개발하고 싶었습니다. 블로그를 꾸준히 관리하고, 버그를 수정하면서 얻게 되는 경험이 도움이 될 것이라고 생각합니다.

제가 고민하고 문제를 해결했던 과정이 다른 사람들에게 도움될 수 있으면 합니다.

💻 기술 스택

✨ 주요기능

• 반응형 웹
• 다크모드
• 코드 하이라이팅
• 글 목차(Table Of Content) 자동 생성
• 댓글 및 이모지 반응 (giscus)
• Configurable: blog-config를 통한 개인 설정
• bio: 자기소개
• seo
• sitemap.xml, robots.txt 자동 생성
• Google Analytics 지원
• 이미지 최적화
• github action을 활용한 자동 배포

🐛 트러블 슈팅

다크모드

• 다크모드 구현 - css variable
• 다크모드 에러 (dark mode flash error) 수정

반응형 웹

• 반응형 웹 - css variable

SEO, 웹접근성

• SEO, 웹 접근성
• Slack에 메타 태그가 적용되지 않는 버그 수정
• SEO 컴포넌트 리팩토링 및 og:image 에러 수정

기타

• github action을 활용한 gh-pages 배포 자동화
• 이미지 처리

🚩 시작 가이드

🎉 설치 및 배포

1. 실행하기

# clone project
$ git clone https://github.com/kimyouknow/kimyouknow.github.io.git

# Install dependencies
$ yarn install

# Start development server
$ yarn dev

2. 배포하기

2-1. 로컬에서 수동으로 배포하기

Github에서 아래와 같이 세팅 후 원하는 브랜치에서 아래 명령어를 실행하면 deploy 빌드파일이 올라가면서 배포됩니다.

• setting -> pages -> Build and deployment -> source: Deploy from a branch

# deploy with gh-pages
$ yarn deploy

2-2. github action을 활용해서 자동으로 배포하기

Github에서 아래와 같이 세팅 후 원하는 main브랜치에 push하면 배포됩니다.

• setting -> pages -> Build and deployment -> source: Github Actions
• .github/workflows/gh-deploy.yml 참고

⚙️ 실행 전 블로그 정보 입력

위의 명령어로 실행하는데 문제가 없었다면 http://localhost:8000 에서 블로그를 확인하실 수 있습니다.

블로그 정보를 수정하고 싶다면 blog-config.js에서 필요한 값을 변경하면 됩니다.

1. 블로그 정보

{
  lang: "", // ko
  title: ``, //Yunho.blog
  author: '', // Yunho(kimyouknow)
  description: ``, // 안녕하세요. 프론트엔드 개발자 김윤호입니다. 고민과 문제 해결 과정을 공유하고 있습니다.
  siteUrl: '', // https://kimyouknow.github.io/
  profileImage: ``, //  static 경로에 있는 사진 파일을 입력하면 프로필 이미지로 반영됩니다. ex) profile-image.png
  mainOgImage :"", // static 경로에 원하는 사진 파일을 입력하면  메인페이지의 og-image 태그로 반영됩니다.
  keywords: [], // 원하는 키워드를 적어주시면 keywords meta태그에 반영됩니다. ex) '개발블로그', '문제해결', 'gatsby'
  favicon: '', // static 경로에 원하는 사진을 넣어주시면 favicon 이미지로 반영됩니다. ex) /static/pencil.png
  social: {
    email: '', // [email protected]
    github: ``, //https://github.com/kimyouknow
    til: '', //https://github.com/kimyouknow/TIL
  },
}

2. 댓글 정보

현재 utterance에서 giscus로 변경했습니다. 자세한 설정은 giscus를 참고해주세요.

{
  data_repo: '',
  data_repo_id: '',
  data_category: '',
  data_category_id: '',
  data_mapping: '',
}

3. 기타 정보

검색 엔진 최적화 및 사이트 분석을 위해 구글 서치 콘솔, Google 애널리틱스, 네이버 웹 마스터 도구에서 필요한 정보를 세팅한 뒤 아래 설정을 변경하셔야 합니다.

{
  seo: {
    google: process.env.GATSBY_SEO_GOOGLE,
    naver: process.env.GATSBY_SEO_NAVER,
  },
  gtag: {
    ga: process.env.GATSBY_ANALYTICS_GOOGLE,
  },
}

환경변수를 개발 환경에서 사용하기 위해서는 아래와 같이 .env파일에 GATSBY_로 시작하는 변수로 등록해주세요.

# env.development와 env.production에 설정에 맞게 id를 입력해주세요.
GATSBY_SEO_GOOGLE=
GATSBY_SEO_NAVER=
GATSBY_ANALYTICS_GOOGLE=

환경변수를 배포 환경에서 사용하기 위해서는 다음과 같은 Github 설정이 필요합니다.

- setting -> secrets and variables -> Actions secrets and variables ->  New secret
- New secret에 .env파일에 작성한 변수를 key:value 형식으로 입력

✏️ 글 작성하기

글을 작성하기 위해 /contents 폴더 내부에 원하시는 분류에 맞게 디렉토리를 생성한 뒤 index.md을 생성해주세요. index.md 파일에는 markdown형식으로 작성하시면 됩니다.

1. 글 목차(Table Of Content)

글 목차를 따로 작성할 필요 없습니다. gatsby-remark-autolink-headers가 markdown의 h태그(h1, h2, h3 ...)를 자동으로 인식해 글 목차를 생성합니다.

2. 마크다운 내 이미지 파일 삽입

markdown 작성 중 이미지를 사용하기 위해서는 index.md와 같은 디렉토리에 이미지 파일을 추가 한 뒤 아래와 같은 방법으로 사용하시면 됩니다.

![이미지](./경로/파일이름.확장자)

3. 포스트 meta 정보

index.md 파일 상단에는 meta 정보를 위한 설정을 해주셔야 합니다.

---
date: '' // 작성 날짜 (yyyy-mm-dd)
title: '' // 제목
categories: [] // 카테고리 ex) 'WEB', '문제해결'
summary: '' // description meta 태그 및 글 목록에서 보여질 짧은 문장
thumbnail: './thumbnail.png'
---

📦 폴더 구조

.
├── contents
│   ├── category1
│   └── category2
│       └── post1
│            ├── index.md
│            └── image.png
├── src
│   ├── Layout # 프로젝트 전체 레이아웃 관리
│   ├── components
│   │   ├── Bio
│   │   ├── CategoryHeader
│   │   ├── Comment
│   │   ├── Footer
│   │   ├── GlobalNavigation
│   │   ├── PostDetail
│   │   ├── PostList
│   │   ├── SEO
│   │   └── Common # 공통 컴포넌트
│   ├── context # context api 관리
│   ├── fonts
│   ├── hooks # custom hooks
│   ├── mocks # mock data
│   ├── pages
│   ├── styles
│   ├── templates #포스트 template
│   ├── types
│   └── utils
└── static # 이미지 파일

✅ 남은 개발 목록

핵심

• : TOC
• : 허스키 (커밋 전 린트 및 프리티어 실행)
• : github action
• : 헤더 글
• : Bio
• : 다크모드 구현
• : SEO 설정, site meta
• : About 페이지
• : 리드미 작성

추가

• : 반응형 웹
• : Read Time
• : Google Analytics
• : 간단한 반응
• : 조회수 표시
• : 검색 기능
• : 카테고리 검색
• : 시리즈 검색
• : 이전 포스트 , 다음 포스트, 최신포스트
• : 맞춤법 검사 자동화 -> vscode-hanspell extension으로 필요할 때마다 사용