Parchment

Parchment란?

Parchment는 독립 페이지와 컬렉션을 만들고 정리하는 데 중점을 둔 간단한 SaaS “Notion 대안”입니다. 페이지로 콘텐츠를 정리하는 개념 중심의 깔끔한 UI를 제공하며, 컬렉션은 그룹화 역할을 합니다.

Parchment의 주요 기능 중 하나는 프로그램적 접근입니다: API를 통해 컬렉션, 페이지, 페이지 내 블록을 관리할 수 있습니다. 이는 코드를 통해 구조화된 페이지 콘텐츠를 만들고, 업데이트하며, 내보낼 수 있는 사용자를 위한 것입니다.

주요 기능

• 컬렉션과 페이지 (API 작업으로 관리): 컬렉션과 페이지를 생성, 이름 변경, 나열, 삭제하여 콘텐츠 구조를 프로그램적으로 제어할 수 있습니다.
• 블록 기반 페이지 콘텐츠: 페이지는 순서가 있는 블록(예: 제목, 텍스트, 목록, 코드, 구분선)으로 구성되며, 이를 추가하거나 교체할 수 있습니다.
• replace_blocks로 전체 페이지 재작성: 페이지의 기존 블록을 모두 삭제하고 새 배열을 순서대로 작성합니다—스크래치부터 완전한 페이지를 생성하는 데 유용합니다.
• append_blocks로 증분 편집: 페이지 끝에 블록을 추가하며 기존 콘텐츠를 교체하지 않아, 추가 작업 흐름을 지원합니다.
• indent_level으로 중첩 목록: bullet_list와 numbered_list 블록은 indent_level 정수(0–4)를 받아 중첩 목록 렌더링을 표현합니다.
• HTML 기반 블록 포맷팅: 블록 콘텐츠는 HTML 문자열로 저장되며, 지원 포맷은 표준 HTML 태그를 통한 굵게, 기울임꼴, 취소선, 링크, 색상 텍스트입니다.
• 그룹 블록 (group / delete_group): 그룹 블록은 자식 블록의 컨테이너 역할을 합니다; 그룹을 생성한 후 group_id로 자식 블록을 연결하고, 한 번에 그룹(및 자식)을 삭제할 수 있습니다.
• 정의된 블록 유형: text, heading1/2/3, bullet_list, numbered_list, todo, quote, divider, code, group을 포함합니다.

Parchment 사용 방법

1. API 키 생성하고 API 기본 URL로 요청을 보냅니다: https://theparchment.app/functions/v1/api.
2. 구조 나열 또는 생성: list_collections로 컬렉션을 나열한 후, 해당 작업(예: create_collection, create_page)으로 컬렉션과 페이지를 생성합니다.
3. 블록으로 페이지 콘텐츠 작성: 기존 페이지 끝에 블록을 추가하려면 append_blocks를, 전체 페이지를 한 번에 재작성하려면 replace_blocks를 사용합니다.
4. HTML 문자열로 콘텐츠 포맷팅: 각 블록의 content를 지원 태그(예: <a href="...">...</a>)를 사용한 HTML 문자열로 제공합니다.
5. 필요 시 그룹으로 정리: 먼저 group 블록을 생성한 후 group_id를 참조하는 자식 블록을 추가합니다; 관련 콘텐츠는 delete_group으로 제거합니다.

사용 사례

• 구조화된 데이터에서 페이지 생성: 단일 진실 원천에서 완전한 페이지 레이아웃(제목, 구분선, 단락, 목록)을 작성하기 위해 replace_blocks를 사용합니다.
• “추가 전용” 문서 로그 구축: 기존 콘텐츠를 방해하지 않고 페이지 끝에 새 섹션, 업데이트, 항목을 추가하기 위해 append_blocks를 사용합니다.
• 계층적 체크리스트 유지: todo 블록(체크박스 항목)을 생성하고 indent_level을 사용한 중첩 bullet_list/numbered_list 블록으로 하위 작업이나 개요를 표현합니다.
• 여러 페이지에서 템플릿 콘텐츠 블록 관리: 페이지를 프로그램적으로 생성하고 이름 변경한 후, 일관된 블록 시퀀스( code 블록 유형을 통한 코드 스니펫 포함)를 삽입합니다.
• 그룹으로 재사용 가능한 섹션 생성: 관련 블록을 함께 유지하기 위해 그룹 블록을 사용하고, delete_group으로 전체 섹션을 삭제하거나 재생성합니다.

자주 묻는 질문

• Parchment API는 어떤 엔드포인트를 사용하나요? API 기본 URL은 https://theparchment.app/functions/v1/api입니다.

• 요청 인증은 어떻게 하나요? 모든 요청에 x-api-key 헤더가 필요합니다. 문서 예시는 x-api-key: pmt_your_key를 보여줍니다.

• append_blocks와 replace_blocks의 차이는 무엇인가요? append_blocks는 기존 블록을 교체하지 않고 페이지 끝에 새 블록을 추가하는 반면, replace_blocks는 기존 블록을 모두 삭제하고 제공된 블록 배열을 순서대로 작성합니다.

• 블록 콘텐츠는 일반 텍스트인가요, HTML인가요? 블록 콘텐츠는 HTML 문자열로 저장되며, 포맷팅은 표준 HTML 태그(예: <strong>, <i>, <a>, <span style="color: ...">)를 사용합니다.

• 중첩 목록은 어떻게 작동하나요? bullet_list와 numbered_list의 경우, 블록은 중첩 하위 목록을 표현하는 indent_level 필드(정수 0–4)를 지원합니다.

대안

• API가 있는 다른 문서 또는 지식 베이스 도구: 코드로 구조화된 페이지를 생성하거나 업데이트해야 한다면, 컬렉션/페이지/블록 모델과 유사한 블록/페이지 API를 제공하는 도구를 찾으세요.
• 범용 위키/문서 플랫폼: 페이지 계층과 템플릿을 지원할 수 있지만, 작업 흐름과 데이터 모델이 다를 수 있습니다(특히 블록 배열을 사용하지 않는 경우).
• 일반 데이터베이스-페이지 접근법: 구조화된 조직이 주요 목표일 때 데이터베이스에서 콘텐츠를 페이지로 렌더링하는 도구가 적합할 수 있지만, 동일한 블록 수준 추가/교체 의미를 제공하지 않을 수 있습니다.
• 로컬 정적 사이트 생성기: 빌드 타임 생성에 익숙한 팀의 경우, 템플릿에서 일관된 페이지를 생성할 수 있지만, SaaS API를 통한 동일한 대화형 페이지 편집 모델을 지원하지 않습니다.