⚽️ TIL, 배운 것을 그때그때 기록하자

프로젝트를 진행하며 겪었던 경험(어떤 문제가 있었고 어떻게 해결했는지), 스터디, 코딩테스트 준비, FE 준비, 매일 공부하며 새로 알게 된 지식 등 배운 것을 구체적으로 기록하려고 합니다.

• TIL 페이지
• GitHub
• Velog
• 코딩테스트 스터디

just-the-docs, jekyll 세팅 방법

jekyll 세팅 jekyll을 먼저 진행한 후에 just-the-docs 테마 사용법 just-the-docs을 통해 테마 적용을 해주세요.

Navigation 카테고리 구성 방법

• 모든 포스팅 마크다운 문서는 ./docs 폴더 내에 만듭니다. 카테고리를 계층 관계로 표현하고 싶은 경우 밑의 예시와 같이 폴더 구조를 만듭니다.
• index.md 파일은 Navigation바에서 해당 항목을 눌렀을 때 처음 나오는 페이지를 의미합니다.

docs/
├─ category1/
│  ├─ index.md
│  ├─ post1.md
├─ category2/
│  ├─ index.md
│  ├─ post2.md

포스팅 작성 방법

모든 마크다운 문서 최상단에 YAML을 설정합니다(navigation구조를 참고하세요).

---
layout: default
title: css Variable
parent: css
grand_parent: FE
nav_order: 1
has_children: false
permalink: /FE/css/cssvar
---

위 YAML을 작성 후 마크다운 문법에 따라 포스팅을 작성하면 됩니다.

Admin 세팅

게시글을 md문법으로 작성하면 되지만 admin페이지를 통해 쉽게 게시글을 작성할 수 있다는 것을 알게 되어 방법을 공유합니다. 참조 링크 먼저, Gemfile파일 안에 해당 부분을 작성합니다.

gem 'jekyll-admin', group: :jekyll_plugins

bundle install
jekyll serve

명령어를 실행하여 http://localhost:4000/admin/에 접근하여 게시물을 작성하고 수정할 수 있습니다.

자동 git commit, push

npm init을 통해 먼저 package.json파일을 작성한 후 shell script 파일을 작성합니다.

"scripts": {
    "commit": "commit/commit.sh"
  },

위 코드를 package.json에 추가해주고 npm run commit명령어를 입력합니다.
아마도 Permission denied 라는 오류가 발생할테지만 터미널 창에 chmod +x commit/commit.sh를 입력하고 다시 npm run commit명령어를 입력하면 성공하는 모습을 볼 수 있습니다. 참고 문서

shell script 종료 상태 확인 방법

if [ $? -ne 1 ]; then
    echo 'commit success😀'
fi

코드를 shell script 파일 아래에 작성해줍니다. 참고 문서

오류 로그

로컬에서 bundle exec jekyll serve를 했을 때, 정상적으로 나타났지만 gh-pages에서는 아래 그림과 같은 빌드 오류가 나타났습니다. “지금까지 잘 되다가 왜 갑자기 오류지?” 라는 생각이었지만 공식 문서에서는 언급하지 않았던 theme: "just-the-docs"를 사용하고 있었다는 사실을 깨닫고 지운 뒤 푸쉬하여 해결하였습니다.