MacOS에서 옵시디언과 깃허브 연동 및 Obsidian-git 플러그인 활용하기

2023. 12. 10. 02:41·notion&obsidian
반응형
 
 

옵시디언은 기본적으로 로컬 pc에 작성한 노트 데이터가 저장된다. 이 데이터를 github 저장소에 연동시키고 옵시디언의 github plugin을 사용해 보자

 

1. Github에 옵시디언 전용 private 저장소 만들기

1-1. 깃허브에 obsidian 전용 저장소를 생성한다.

  • 나의 깃허브로 이동해서 obsidian 폴더의 파일들을 저장하기 위한 깃허브 repository를 private으로 생성해 준다.

깃허브 저장소 생성하기
깃허브 저장소 생성하기

 

나는 옵시디언을 설치할때 저장될 폴더를 내가 지정해서 생성했고 작성한 글은 모두 이 폴더에 자동으로 저장되었다.
그래서 이미 사용중이던 폴더에 들어가서 gitHub 저장소와 연결을 진행했다.


2. 옵시디언 저장 폴더 Github에 연결하기

2-1. init 명령어를 입력

  • 옵시디언 저장소 폴더에 들어가서 init 명령어를 입력한다.
git init

git init 명령어 입력
git init 명령어 입력

  • init 명령어 입력시 아래와 같이 나올 것이다.

init 명령어 입력 후 반응
init 명령어 입력 후 반응

 

2-2. init 한 폴더와 git repository (원격 저장소)를 연결한다.

  • "git remote add origin {GitHub repository 주소}" 명령어는 로컬 Git 저장소를 GitHub에 생성한 원격 저장소와 연결하는 데 사용된다. 이 과정은 로컬에서 작업한 내용을 원격 저장소로 푸시(push)하거나, 원격 저장소의 변경 사항을 로컬로 풀(pull) 하기 위해 필수적인 단계다.
git remote add origin {만들어준 github repository 주소}

깃 원격 저장소 연결하기
깃 원격 저장소 연결하기

 

  • 이때 "github repository" 주소는 아래처럼 github에 생성한 저장소에서 "code"버튼을 누르면 보이는 https 주소를 적어준다.

리포지토리 주소 확인하기
리포지토리 주소 확인하기

 

2-3. git pull 명령어 입력

  • 깃허브 저장소의 내용을 가져온다. (새롭게 생성한 repository라서 readme정도만 가져올 것이다.)
git pull

저장소 내용 땡겨오기
저장소 내용 땡겨오기

 

 

이렇게 obsidian 저장소를 GitHub repository와 연동하는 데 성공했다. 이제 옵시디언 플러그인 설정을 진행하자


3. 옵시디언에서 obsidian-git 플러그인 설치하기

3-1. 환경설정 들어가기

  • 옵시디언 좌측 하단의 톱니바퀴 모양 아이콘을 클릭한다.

환경설정
환경설정

3-2. 플러그인 탐색하기

  • 환경설정 메뉴에서 "커뮤니티 플러그인"을 클릭한 후에 "탐색" 버튼을 누른다.

플러그인 탐색
플러그인 탐색

3-3. obsidian git 검색 후 설치하기

  • 검색하면 아래와 같이 나올 텐데 Obsidian Git에 클릭해서 들어가자 (나는 이미 설치한 상태였고 글을 작성하기 위해 제거를 했다.)

옵시디언 깃 검색
옵시디언 깃 검색

  • Obsidian Git을 클릭하면 아래처럼 화면이 바뀔 텐데 여기서 "설치" 버튼을 누른다.

옵시디언 깃 설치
옵시디언 깃 설치

3-4. obsidian git 활성화하기

  • 설치가 완료되면 아래와 같이 화면이 바뀌는데 여기서 "활성화" 버튼을 클릭한다.

옵시디언 깃 활성화
옵시디언 깃 활성화

3-5. 플러그인 옵션 설정하기

  • 활성화를 하면 아래와 같은 화면이 나올 텐데 "옵션" 버튼을 클릭한다.

옵션 클릭
옵션 클릭

  • 옵션 최상단에 적혀있는 Automatic 설정을 해준다. (여기서 잘 설정하면 플러그인이 알아서 commit&push를 해준다.) 하단의 설명을 보고 와서 설정하면 된다.

옵시디언 깃 자동화 설정하기
옵시디언 깃 자동화 설정하기

3-6. Automatic설정에 대한 설명

  1. Split Automatic Commit and Push
  • 이 설정은 자동 커밋과 푸시를 분리하는 기능이다. 즉, 파일 변경사항이 자동으로 커밋되는 것과 이러한 변경사항이 원격 저장소로 푸시되는 것을 별도로 관리할 수 있게 해준다. 이는 버전 관리를 더 세밀하게 할 수 있게 해준다.
  2. Vault Backup Interval (Minutes)
  • 이 설정은 옵시디언 Vault(노트 저장소)의 백업 간격을 분 단위로 설정하는 것이다. 예를 들어, 60분으로 설정하면, Vault는 60분마다 자동으로 백업된다.
  3. Auto Backup After Stop Editing Any File
  • 파일 편집을 중단한 후 자동 백업이 이루어지는 설정이다. 이는 사용자가 파일 작업을 마친 후 자동으로 백업이 진행되도록 함으로써, 변경사항을 지속적으로 안전하게 보존할 수 있게 해준다.
  4. Auto Backup After Latest Commit
  • 이 설정은 최신 커밋 이후 자동으로 백업을 수행하는 기능이다. 즉, 최근에 수행된 커밋 이후에 변경사항이 있을 때마다 자동으로 백업이 이루어진다.
  5. Auto Pull Interval (Minutes)
  • 이 설정은 자동으로 원격 저장소에서 변경사항을 가져오는 (pull) 간격을 설정하는 것이다. 예를 들어, 이 값을 10분으로 설정하면, 10분마다 원격 저장소의 최신 변경사항을 자동으로 가져온다.
  6. Specify Custom Commit Message on Auto Backup
  • 자동 백업 시 사용자 지정 커밋 메시지를 설정하는 기능이다. 이를 통해 사용자가 원하는 특정 메시지를 커밋에 포함시킬 수 있다.
  7. Commit Message on Auto Backup/Commit
  • 자동 백업이나 커밋 시 사용되는 커밋 메시지를 설정하는 기능이다. 이 설정을 통해 각 커밋에 대한 설명을 추가할 수 있어, 이후 변경사항을 추적하거나 이해하는 데 도움이 된다.
나는 모든 automatic 설정은 off 해줬다. 직접 커밋을 관리해주고 싶었기 때문이다. 아마 여기서 많이 갈라질 텐데 이 automatic설정을 사용하면 직접 commit&push를 안 해도 알아서 지정된 시간마다 commit&push가 이루어진다. 이렇게 편하게 해 주기 때문에 이 플러그인을 사용하는 것 같다.

 

 

이제 옵시디언 폴더에 있던 파일들을 Github 저장소에 넣자


4. 옵시디언 폴더에 들어있는 내용 Github 저장소에 넣기

4-1. add 명령어를 입력한다.

git add .

git add
git add

 

4-2. 상태를 확인한다.

git status

git status
git status

 

4-3. 커밋 메시지를 입력하고 커밋한다.

git commit -m "{내가 원하는 메시지 입력하기}"

git commit message
git commit message

 

4-4. git push 명령어로 저장소에 옵시디언 폴더 내용을 넣어준다.

git push

깃 저장소에 파일 넣기
깃 저장소에 파일 넣기

 

4-5. git repository에 들어가서 잘 저장되었는지 확인

  • 내가 적었던 파일들이 잘 저장된 것을 확인할 수 있다.

깃 리포지토리 확인
깃 리포지토리 확인

 

 

사실 이렇게 보면 obsidian에서 git plugin을 쓸 필요가 없어 보인다. 그런데 여기서 Obsidian git 플러그인을 쓰면 얻을 수 있는 장점이 있다. 바로 전용 명령어 팔레트 기능을 사용할 수 있다는 것이다.


5. 플러그인이 지원하는 명령 팔레트 사용하기

5-1. 명령어 팔레트 열기

  • 옵시디언 좌측 메뉴바에서 "명령어 팔레트" 아이콘을 클릭한다.

옵시디언 명령어 팔레트 열기
옵시디언 명령어 팔레트 열기

5-2. "명령어 팔레트"에 git을 검색한다.

  • 우리가 많이 사용하는 commit, push, fetch, pull 등의 많은 git 명령어를 클릭만으로 사용가능하도록 플러그인이 지원해 준다.

옵시디언 git 플러그인 명령어 팔레트 기능
옵시디언 git 플러그인 명령어 팔레트 기능

 

6. 플러그인 설정에서 커밋 author 설정하기

옵시디언에 글을 열심히 작성하고 내용을 커밋까지 했는데 내가 커밋하고 푸시한 내용에 대한 "잔디"가 쌓이지 않는다면 어떨 것 같은가? 당연히 화날 것이다. 그렇다면 이 글을 읽고 제대로 설정을 진행하자

 

6-1. 잔디가 쌓이지 않는 이유 파악

  • Obsidian-Git 플러그인을 사용하여 Obsidian 내에서 커밋과 푸시를 진행했을 때 GitHub의 잔디(컨트리뷰션 그래프)가 쌓이지 않는 문제는 주로 Git 커밋에 사용되는 사용자 이메일이 GitHub 계정과 일치하지 않을 때 발생한다. GitHub는 커밋에 있는 이메일 주소를 기반으로 잔디를 쌓는다. 만약 이메일이 GitHub 계정과 매칭되지 않으면 잔디가 생기지 않는다.

 

6-2. 잔디가 쌓이도록 플러그인 내부 설정하기

  • obsidian-git 플러그인 설정에는 "Commit Author" 항목이 존재한다. 여기에서 꼭 github 계정에 설정된 name과 email을 알맞게 적어주도록 하자 (나는 제대로 안 읽고 email에 실수로 name을 적었더니 모든 커밋이 잔디가 안 생기고 진행되었다.)

commit author 설정
commit author 설정

 

 

이렇게 Commit Author를 수정하고 commit&push를 진행하니 잔디가 제대로 쌓였다.

 

 

 

옵시디언에서 코드 블록 스타일을 노션처럼 만드는 방법👇🏻👇🏻

 

옵시디언의 코드 블럭을 노션 스타일로 변화시키기 - 옵시디언에 커스텀 css 적용하기

옵시디언에서 노션 스타일의 코드 블록으로 커스터마이징 하기 옵시디언 코드 블럭의 문제점을 알아보자 1. 옵시디언 코드 블록의 문제점 나는 옵시디언에서도 코드를 이쁘게 보고 싶은데 코드

curiousjinan.tistory.com

옵시디언에서 이미지 저장 경로 폴더를 지정하는 방법👇🏻👇🏻

 

옵시디언에서 이미지 저장 경로 설정하기

옵시디언의 이미지 저장 경로를 지정해 보자 옵시디언에서 글을 작성하던 중 이미지를 추가하면 계속 root 폴더에 이미지가 저장되어 폴더가 지저분해졌다. 1. 옵시디언의 이미지가 root 디렉토리

curiousjinan.tistory.com

 

반응형

'notion&obsidian' 카테고리의 다른 글

옵시디언에서 이미지 저장 경로 설정하기  (3) 2023.12.10
[옵시디언] Obsidian 코드 블럭 노션(notion) 처럼 만들기  (1) 2023.12.10
'notion&obsidian' 카테고리의 다른 글
  • 옵시디언에서 이미지 저장 경로 설정하기
  • [옵시디언] Obsidian 코드 블럭 노션(notion) 처럼 만들기
Stark97
Stark97
문의사항 또는 커피챗 요청은 링크드인 메신저를 보내주세요! : https://www.linkedin.com/in/writedev/
  • Stark97
    오늘도 개발중입니다
    Stark97
  • 전체
    오늘
    어제
    • 분류 전체보기 (240)
      • 개발지식 (20)
        • 스레드(Thread) (8)
        • WEB, DB, GIT (3)
        • 디자인패턴 (8)
      • JAVA (21)
      • Spring (88)
        • Spring 기초 지식 (35)
        • Spring 설정 (6)
        • JPA (7)
        • Spring Security (17)
        • Spring에서 Java 활용하기 (8)
        • 테스트 코드 (15)
      • 아키텍처 (5)
      • MSA (14)
      • DDD (7)
      • gRPC (9)
      • Apache Kafka (18)
      • DevOps (23)
        • nGrinder (4)
        • Docker (1)
        • k8s (1)
        • 테라폼(Terraform) (12)
      • AWS (32)
        • ECS, ECR (14)
        • EC2 (2)
        • CodePipeline, CICD (8)
        • SNS, SQS (5)
        • RDS (2)
      • notion&obsidian (3)
  • 링크

    • notion기록
    • 깃허브
    • 링크드인
  • hELLO· Designed By정상우.v4.10.0
Stark97
MacOS에서 옵시디언과 깃허브 연동 및 Obsidian-git 플러그인 활용하기
상단으로

티스토리툴바