https://github.com/bnbong/bnbong.github.io

bnbong's Personal Repository
https://github.com/bnbong/bnbong.github.io

Last synced: 5 months ago
JSON representation

bnbong's Personal Repository

• Host: GitHub
• URL: https://github.com/bnbong/bnbong.github.io
• Owner: bnbong
• License: mit
• Created: 2019-09-15T02:53:35.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-09-30T06:46:41.000Z (about 3 years ago)
• Last Synced: 2024-08-03T05:01:40.728Z (about 1 year ago)
• Language: Java
• Homepage: https://bnbong.github.io/
• Size: 590 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bnbong's tech Blog

기술 관련 내용을 포스팅하는 블로그 소스코드 저장소입니다.

## Stack

> with [material for MKDocs](https://squidfunk.github.io/mkdocs-material/)

- Python 3.12.4

- Material for MKDocs

## Blog Convention

### material for MKDocs general convention

https://squidfunk.github.io/mkdocs-material/conventions/

### bnbong's blog specific convention

#### 마크다운 본문 작성 시 주의사항

- .md 파일 최상단에 정의하는 메타데이터의 title이 문서 렌더 시 H1 태그로 렌더링된다.

  따라서 본문 작성 시 문서 시작 부분에는 H1 태그를 사용하지 않는다.

- 블로그 포스팅은 docs/blog/posts 디렉토리 내에 {년월일-제목} 형식의 폴더 생성 후 그 안에 .md 파일로 본문을 작성한다.

  - 이미지 파일은 같은 디렉토리 내에 images 폴더를 생성 후 그 안에 저장한다.

  - 폴더 타이틀 작명은 항상 slug 타이틀로 적지 않아도 됨, 영어로 작성하는 것을 권장.

- Category, Tags 이름은 영어 대문자로 시작하도록 작성한다.

## MileStone

- [ ] Portfolio, Blog, Project 컨텐츠 추가

- [ ] Notion과 연동? (가능성 낮음)