Parchment

¿Qué es Parchment?

Parchment es un SaaS simple “alternativa a Notion” centrado en crear y organizar páginas y colecciones independientes. Ofrece una interfaz limpia conceptualmente centrada en organizar contenido en páginas, con colecciones que actúan como agrupaciones.

Una parte principal de la funcionalidad de Parchment es el acceso programático: puedes gestionar colecciones, páginas y los bloques dentro de las páginas mediante una API. Esto está pensado para usuarios que desean contenido de página estructurado que puedan crear, actualizar y exportar a través de código.

Características clave

• Colecciones y páginas (gestionadas vía acciones de API): Crea, renombra, lista y elimina colecciones y páginas para controlar la estructura de contenido de forma programática.
• Contenido de página basado en bloques: Las páginas se componen de bloques ordenados (p. ej., encabezados, texto, listas, código, divisores) que puedes agregar o reemplazar.
• Reescrituras completas de página con replace_blocks: Replace elimina todos los bloques existentes en la página y escribe un nuevo array en orden; útil para generar una página completa desde cero.
• Ediciones incrementales con append_blocks: Append agrega bloques al final de una página y no reemplaza el contenido existente, compatible con flujos de trabajo aditivos.
• Listas anidadas con indent_level: Los bloques bullet_list y numbered_list aceptan un entero indent_level (0–4) para representar el renderizado de listas anidadas.
• Formato de bloques basado en HTML: El contenido de los bloques se almacena como cadenas HTML; el formato compatible incluye negrita, cursiva, tachado, enlaces y texto coloreado mediante etiquetas HTML estándar.
• Bloques de grupo (group / delete_group): Un bloque de grupo actúa como contenedor para bloques hijos; creas el grupo, luego asocias bloques hijos con group_id, y puedes eliminar el grupo (y sus hijos) en una sola operación.
• Tipos de bloques definidos: Incluye text, heading1/2/3, bullet_list, numbered_list, todo, quote, divider, code y group.

Cómo usar Parchment

1. Crea una clave API y envía solicitudes a la URL base de la API: https://theparchment.app/functions/v1/api.
2. Lista o crea estructura: Comienza listando colecciones (list_collections), luego crea colecciones y páginas usando las acciones correspondientes (p. ej., create_collection, create_page).
3. Escribe contenido de página usando bloques: Usa append_blocks para agregar bloques al final de una página existente, o replace_blocks para reescribir toda la página en una sola llamada.
4. Formatea contenido con cadenas HTML: Proporciona el content de cada bloque como una cadena HTML usando etiquetas compatibles (por ejemplo, enlaces vía <a href="...">...</a>).
5. Organiza con agrupación cuando sea necesario: Crea primero un bloque group, luego agrega bloques hijos que referencien el grupo vía group_id; elimina contenido relacionado usando delete_group.

Casos de uso

• Genera páginas desde datos estructurados: Usa replace_blocks para escribir un diseño de página completo (encabezados, divisores, párrafos, listas) desde una única fuente de verdad.
• Construye registros de documentación “solo agregar”: Usa append_blocks para agregar nuevas secciones, actualizaciones o entradas al final de una página sin alterar el contenido previo.
• Mantén listas de verificación jerárquicas: Crea bloques todo (elementos con casilla) y usa bloques bullet_list/numbered_list anidados con indent_level para representar subtareas u esquemas.
• Gestiona bloques de contenido con plantillas en múltiples páginas: Crea y renombra páginas de forma programática, luego inserta secuencias de bloques consistentes (incluyendo fragmentos de código vía el tipo de bloque code).
• Crea secciones reutilizables vía agrupación: Usa bloques de grupo para mantener bloques relacionados juntos, y elimina o regenera una sección completa usando delete_group.

Preguntas frecuentes

• ¿Qué endpoint usa la API de Parchment? La URL base de la API es https://theparchment.app/functions/v1/api.

• ¿Cómo autentico las solicitudes? Todas las solicitudes requieren un encabezado x-api-key. Los ejemplos de documentación muestran x-api-key: pmt_your_key.

• ¿Cuál es la diferencia entre append_blocks y replace_blocks? append_blocks agrega nuevos bloques al final de la página sin reemplazar los existentes, mientras que replace_blocks elimina todos los bloques existentes y escribe los bloques proporcionados en orden de array.

• ¿El contenido de los bloques es texto plano o HTML? El contenido de los bloques se almacena como cadenas HTML; el formato usa etiquetas HTML estándar (p. ej., <strong>, <i>, <a> y <span style="color: ...">).

• ¿Cómo funcionan las listas anidadas? Para bullet_list y numbered_list, los bloques admiten un campo indent_level (entero 0–4) para representar sublistas anidadas.

Alternativas

• Otras herramientas de documentación o bases de conocimiento con API: Si necesitas generar o actualizar páginas estructuradas vía código, busca herramientas que ofrezcan APIs de bloques/páginas similares al modelo de colección/página/bloque.
• Plataformas generales de wiki/documentación: Pueden soportar jerarquías de páginas y plantillas, pero el flujo de trabajo y el modelo de datos pueden diferir (especialmente si no usan arrays de bloques).
• Enfoques genéricos de base de datos a páginas: Herramientas que renderizan contenido desde una base de datos en páginas pueden encajar cuando tu objetivo principal es organización estructurada, aunque no ofrezcan las mismas semánticas de agregar/reemplazar a nivel de bloque.
• Generadores de sitios estáticos locales: Para equipos cómodos con generación en tiempo de compilación, las herramientas de sitios estáticos pueden producir páginas consistentes desde plantillas, pero típicamente no admiten el mismo modelo de edición interactiva de páginas vía API SaaS.