컨텐츠로 건너뛰기
girok-md

설정

girok-md는 프로젝트 루트의 setting.toml 파일로 설정합니다.

기본 설정

setting.toml
# 필수: 마크다운 파일 경로
source_root_path = "/path/to/your/obsidian/vault"


# 블로그 이름 (헤더와 메타데이터에 표시)
blog_name = "내 블로그"


# SEO용 사이트 URL (사이트맵, canonical URL)
site_url = "https://username.github.io"


# 언어: "en" 또는 "ko"
locale = "ko"

설정 옵션

source_root_path

필수. 마크다운 폴더의 절대 경로 (예: Obsidian vault).

source_root_path = "/Users/john/Documents/Obsidian/MyVault"

blog_name

블로그 이름. 헤더에 표시되고 페이지 제목에 사용됩니다.

blog_name = "John의 기술 블로그"

site_url

사이트 URL. 다음 용도로 사용됩니다:

  • sitemap.xml 생성
  • SEO를 위한 canonical URL 설정
  • Open Graph 메타 태그
site_url = "https://john.github.io"

locale

블로그의 기본 언어. 날짜 형식과 UI 레이블에 영향을 줍니다.

locale = "ko"  # 또는 영어는 "en"

인트로 섹션

홈페이지에 표시되는 인트로 섹션 설정:

[intro]
title = "내 블로그에 오신 것을 환영합니다"
description = "기술과 삶에 대한 생각을 공유합니다"

환경 변수

민감한 값에는 환경 변수를 사용할 수 있습니다:

.env 파일 생성:

.env
PUBLIC_SITE_URL=https://your-site.com

설정 후 파일 구조

npm run sync 실행 후 프로젝트 구조:

your-blog/
├── setting.toml           # 설정 파일
├── src/
│   └── content/
│       └── posts/         # 동기화된 마크다운 파일
├── public/
│   └── assets/            # 동기화된 이미지
└── ...

댓글

Giscus를 사용하여 블로그 포스트에 댓글 기능을 추가할 수 있습니다. Giscus는 GitHub Discussions 기반의 댓글 시스템입니다.

설정 방법

  1. GitHub Discussions 활성화:

    • 저장소 → Settings → General → Features
    • “Discussions” 체크

  2. Giscus 앱 설치:

  3. 설정 생성:

    • giscus.app 방문
    • 저장소 정보 입력
    • 생성된 값 복사

  4. setting.toml 업데이트:

setting.toml
[comments]
enabled = true
provider = "giscus"


[comments.giscus]
repo = "username/repo"
repo_id = "R_kgDOxxxxxx"
category = "Announcements"
category_id = "DIC_kwDOxxxxxx"
mapping = "pathname"
strict = "0"
reactions_enabled = "1"
emit_metadata = "0"
input_position = "top"
theme = "preferred_color_scheme"
lang = "ko"

설정 옵션

옵션설명값
enabled댓글 활성화/비활성화true / false
provider댓글 시스템 제공자"giscus"
repoGitHub 저장소"username/repo"
repo_idgiscus.app에서 생성된 저장소 ID"R_kgDOxxxxxx"
categoryDiscussion 카테고리 이름"Announcements", "General" 등
category_idgiscus.app에서 생성된 카테고리 ID"DIC_kwDOxxxxxx"
mapping포스트와 Discussion 매핑 방식"pathname", "url", "title", "og:title"
strict엄격한 제목 매칭"0" (끔) / "1" (켬)
reactions_enabled반응 활성화"0" (끔) / "1" (켬)
emit_metadataDiscussion 메타데이터 전송"0" (끔) / "1" (켬)
input_position댓글 입력창 위치"top" / "bottom"
theme색상 테마"light", "dark", "preferred_color_scheme"
lang언어"en", "ko", "ja", "zh-CN" 등

다음 단계