OutlineToObsidian Project - swkim0128/PARA GitHub Wiki

Outline 툴과 Obsidian 툴을 동기화할 수 있는 프로젝트입니다. 사용자는 Outline에 저장된 데이터를 로컬 PC에 마크다운 파일로 다운로드하고, Obsidian을 통해 데이터를 수정하거나 관리할 수 있습니다. 로컬 PC에서의 변경 사항은 Outline과 자동으로 동기화됩니다.

• 효율적인 문서 관리: Outline과 Obsidian의 강점을 활용하여 유연한 문서 관리 체계를 구축합니다.
• 데이터 일관성 유지: 로컬 파일 수정 시 Outline과 동기화하여 데이터의 최신 상태를 유지합니다.

---

1. Obsidian 커뮤니티 플러그인 지원

   • Obsidian 내에서 플러그인을 다운로드하여 사용할 수 있도록 지원합니다.

2. 설정 기능

   • Obsidian 내에서 Outline API 연동을 위한 URL 및 personal token을 설정할 수 있어야 합니다.
   • 특정 컬렉션을 설정하여 해당 컬렉션 내 문서를 동기화할 수 있도록 합니다.
   • 동기화 주기를 설정할 수 있는 기능을 제공합니다.

3. Outline API 연동 및 데이터 동기화

   • Obsidian에서 설정한 컬렉션의 문서를 마크다운 파일로 다운로드합니다.
   • 로컬에서 수정된 파일이 Outline에도 자동으로 반영되도록 합니다.
   • Outline API를 감싸서 Obsidian에서 쉽게 사용할 수 있도록 지원합니다.
   • Outline에서 제공하는 API 예제를 포함하여 문서화합니다.

4. 파일 충돌 방지 및 관리

   • 같은 디렉터리 경로 내에 동일한 제목의 파일이 존재할 경우 해결 방안을 마련합니다.

---

1. Obsidian 플러그인 개발 방법 확인

   • 플러그인 변수 설정 방법 확인
   • Obsidian에서 외부 API 요청하는 방법 확인

2. Outline API 확인

   • Outline에서 제공하는 API 목록을 검토하고 활용 방안을 정리합니다.

---

• Obsidian 내에서 Outline API URL을 설정할 수 있도록 합니다.
• Personal token을 입력하여 인증을 진행할 수 있도록 합니다.
• 동기화할 컬렉션을 설정할 수 있도록 합니다.
• 동기화 주기를 설정하는 기능을 추가합니다.

• Obsidian에서 설정한 컬렉션 내 문서를 마크다운 파일로 다운로드합니다.
• 로컬 파일이 수정되면 Outline에도 자동으로 반영됩니다.
• Outline에서 문서가 수정되었을 경우, Obsidian 내 파일도 업데이트됩니다.

• Obsidian에서 파일을 저장하면 Outline에도 자동 반영됩니다.
• 새로 생성한 파일을 Outline의 특정 위치에 업로드할 수 있도록 지원합니다.

• 같은 디렉터리 내 동일한 제목의 파일이 있을 경우, 이를 처리할 방법을 제공합니다.

---

1. 인증

   • Endpoint: /auth (OAuth2 지원)
   • 기능: 사용자 인증 및 토큰 발급

2. 문서 목록 가져오기

   • Endpoint: /documents.list
   • 기능: Outline 내의 문서 목록을 가져옵니다.
   • 응답 데이터: 문서 ID, 제목, 경로, 수정 날짜 등

3. 문서 상세 정보

   • Endpoint: /documents.info
   • 기능: 특정 문서의 상세 정보를 가져옵니다.
   • 응답 데이터: 본문 내용, 작성자, 태그 등

4. 문서 생성

   • Endpoint: /documents.create
   • 기능: 새로운 문서를 생성합니다.

5. 문서 수정

   • Endpoint: /documents.update
   • 기능: 기존 문서를 수정합니다.

6. 문서 삭제

   • Endpoint: /documents.delete
   • 기능: 문서를 삭제합니다.

---

1. 플러그인 설정 파일

   • manifest.json: 플러그인의 메타데이터를 정의합니다.

     {
       "id": "outline-sync",
       "name": "Outline Sync",
       "version": "1.0.0",
       "author": "Your Name",
       "minAppVersion": "0.12.0"
     }

2. 플러그인 엔트리 파일

   • main.js: 플러그인의 진입점으로 동작하는 로직 작성

     import { Plugin } from 'obsidian';
     
     export default class OutlineSyncPlugin extends Plugin {
       async onload() {
         console.log('Outline Sync Plugin Loaded');
         // 동기화 로직 추가
       }
     
       onunload() {
         console.log('Outline Sync Plugin Unloaded');
       }
     }

1. Outline API 호출

   • fetch API를 사용하여 Outline 데이터를 가져오거나 수정합니다.

2. 파일 관리

   • Obsidian의 파일 API를 사용하여 로컬 파일을 읽고 씁니다.

     this.app.vault.adapter.write('path/to/file.md', 'Markdown content');

3. 이벤트 리스너 등록

   • 파일 변경 이벤트를 감지하여 동기화 트리거로 활용합니다.

     this.registerEvent(
       this.app.vault.on('modify', (file) => {
         console.log(`${file.path} was modified.`);
         // Outline 업데이트 로직 추가
       })
     );

• 디버깅: Obsidian 개발자 도구를 활용하여 오류를 디버깅합니다.
• 배포: GitHub 저장소에 코드를 업로드하고 Obsidian 플러그인 저장소에 등록합니다.

---

4. 프로토타입 구현

   • Outline API를 통해 데이터를 가져오는 로직과 Obsidian 플러그인 기본 구조를 구현합니다.

5. 동기화 로직 개선

   • 양방향 동기화 및 충돌 관리 알고리즘을 설계합니다.

6. 사용자 피드백 반영

   • 초기 사용자 피드백을 받아 기능을 개선합니다.

7. 최종 배포

   • 문서화 및 튜토리얼 제공 후 프로젝트를 배포합니다.