UStackUStack
Parchment icon

Parchment

Parchment 是一款简单SaaS,可用区块编辑创建并管理独立页面与集合,并提供 API 以编程方式管理集合、页面和区块。

Parchment

什么是 Parchment?

Parchment 是一款简单的 SaaS“ Notion 替代品”,围绕创建和组织独立页面与集合构建。它提供简洁的 UI,概念上以将内容组织成页面为中心,集合则作为分组。

Parchment 功能的重要部分是程序化访问:您可以通过 API 管理集合、页面以及页面内的区块。这适用于希望通过代码创建、更新和导出结构化页面内容的用户。

主要功能

  • 集合和页面(通过 API 操作管理): 创建、重命名、列出和删除集合与页面,以便以编程方式控制内容结构。
  • 基于区块的页面内容: 页面由有序区块组成(例如标题、文本、列表、代码、分隔线),您可以添加或替换这些区块。
  • 使用 replace_blocks 完全重写页面: replace_blocks 会删除页面上所有现有区块,并按顺序写入新数组——适用于从零生成完整页面。
  • 使用 append_blocks 增量编辑: append_blocks 将区块添加到页面末尾,不会替换现有内容,支持增量工作流。
  • 使用 indent_level 的嵌套列表: bullet_listnumbered_list 区块接受 indent_level 整数(0–4)来表示嵌套列表渲染。
  • 基于 HTML 的区块格式化: 区块内容以 HTML 字符串存储;支持的格式包括粗体、斜体、删除线、链接,以及通过标准 HTML 标签的彩色文本。
  • 分组区块(group / delete_group): 分组区块作为子区块的容器;您先创建分组,然后通过 group_id 将子区块关联,最后可一次性删除分组(及其子区块)。
  • 定义的区块类型: 包括 textheading1/2/3bullet_listnumbered_listtodoquotedividercodegroup

如何使用 Parchment

  1. 创建 API 密钥 并向 API 基础 URL 发送请求:https://theparchment.app/functions/v1/api
  2. 列出或创建结构: 先使用 list_collections 列出集合,然后使用相应操作创建集合和页面(例如 create_collectioncreate_page)。
  3. 使用区块编写页面内容: 使用 append_blocks 将区块添加到现有页面末尾,或使用 replace_blocks 一次性重写整个页面。
  4. 使用 HTML 字符串格式化内容: 为每个区块的 content 提供 HTML 字符串,使用支持的标签(例如,通过 <a href="...">...</a> 添加链接)。
  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_blocksreplace_blocks 有什么区别?

    append_blocks 将新区块添加到页面末尾而不替换现有区块,而 replace_blocks 删除所有现有区块并按数组顺序写入提供的区块。

  • 区块内容是纯文本还是 HTML?

    区块内容以 HTML 字符串存储;格式化使用标准 HTML 标签(例如 <strong><i><a><span style="color: ...">)。

  • 嵌套列表如何工作?

    对于 bullet_listnumbered_list,区块支持 indent_level 字段(整数 0–4)来表示嵌套子列表。

替代方案

  • 其他带 API 的文档或知识库工具: 如果需要通过代码生成或更新结构化页面,请寻找提供类似于集合/页面/区块模型的区块/页面 API 的工具。
  • 通用 wiki/文档平台: 这些平台支持页面层级和模板化,但工作流和数据模型可能不同(尤其是如果它们不使用区块数组)。
  • 通用数据库到页面的方法: 当主要目标是结构化组织时,从数据库渲染内容到页面的工具可能合适,尽管它们可能不提供相同的区块级追加/替换语义。
  • 本地静态站点生成器: 对于习惯构建时生成内容的团队,静态站点工具可从模板生成一致页面,但通常不支持通过 SaaS API 的相同交互式页面编辑模型。
Parchment | UStack