컨텐츠로 건너뛰기
girok-md

빠른 시작

몇 분 만에 블로그를 만들고 실행할 수 있습니다.

직접 실행

사전 요구사항

  • Node.js v20 이상
  • Git
  • 마크다운 파일이 있는 폴더 (예: Obsidian vault)

  1. 저장소 생성

    girok-md 저장소에서 Use this template 버튼을 클릭하여 나만의 저장소를 생성합니다.

  2. 클론 및 의존성 설치

    Terminal window
    git clone https://github.com/YOUR_USERNAME/YOUR_REPO.git
    cd YOUR_REPO
    npm install

  3. 블로그 설정

    setting.toml 파일을 수정합니다:

    setting.toml
    # 마크다운 파일의 절대 경로
    source_root_path = "/path/to/your/obsidian/vault"
    

    # 블로그 이름
    blog_name = "내 블로그"
    

    # 사이트 URL (SEO용)
    site_url = "https://your-username.github.io"
    

    # 언어 (en 또는 ko)
    locale = "ko"

  4. 포스트 동기화

    Terminal window
    npm run sync

    이 명령어는 마크다운 폴더를 스캔하여 frontmatter에 publish: true가 있는 파일을 복사합니다.

  5. 개발 서버 시작

    Terminal window
    npm run dev

    http://localhost:4321에서 블로그를 확인하세요!

Docker로 시작하기

사전 요구사항

Docker Compose로 girok-md를 4단계로 간편하게 실행할 수 있습니다.

  1. 저장소 클론

    Terminal window
    git clone https://github.com/7loro/girok-md.git
    cd girok-md

  2. 테스트용 마크다운 파일 준비

    아무 폴더에 publish: true frontmatter가 포함된 마크다운 파일을 생성합니다:

    Terminal window
    mkdir -p ~/my-posts
    cat > ~/my-posts/hello.md << 'EOF'
    ---
    title: Hello World
    publish: true
    ---
    

    첫 번째 블로그 포스트입니다!
    EOF

  3. docker-compose.yml 볼륨 경로 수정

    /path/to/your/markdown-folder를 실제 마크다운 폴더 경로로 변경합니다:

    docker-compose.yml
    volumes:
      # 예시: ~/my-posts, /Users/me/ObsidianVault 등
      - ~/my-posts:/source:ro
      - ./setting.toml:/app/setting.toml:ro

  4. Docker Compose로 실행

    Terminal window
    docker compose up -d

    http://localhost:8080에서 블로그를 확인하세요!

다음 단계

  • 설정 - 모든 설정 옵션 알아보기
  • 포스트 작성 - 포스트 작성 및 포맷팅 방법
  • 배포 - GitHub Pages에 블로그 배포하기