Parchment

O que é Parchment?

Parchment é um SaaS simples, “alternativa ao Notion”, construído em torno da criação e organização de páginas e coleções independentes. Ele oferece uma interface limpa, conceitualmente centrada na organização de conteúdo em páginas, com coleções atuando como agrupamentos.

Uma parte principal da funcionalidade do Parchment é o acesso programático: você pode gerenciar coleções, páginas e os blocos dentro das páginas via API. Isso é destinado a usuários que desejam conteúdo de página estruturado que possam criar, atualizar e exportar por meio de código.

Principais Recursos

• Coleções e páginas (gerenciadas via ações de API): Crie, renomeie, liste e delete coleções e páginas para que a estrutura de conteúdo possa ser controlada programaticamente.
• Conteúdo de página baseado em blocos: Páginas são compostas por blocos ordenados (ex.: títulos, texto, listas, código, divisores) que você pode adicionar ou substituir.
• Reescrita completa de página com replace_blocks: Replace deleta todos os blocos existentes na página e escreve um novo array em ordem — útil para gerar uma página completa do zero.
• Edições incrementais com append_blocks: Append adiciona blocos ao final de uma página e não substitui o conteúdo existente, suportando fluxos de trabalho aditivos.
• Listas aninhadas com indent_level: Blocos bullet_list e numbered_list aceitam um inteiro indent_level (0–4) para representar renderização de listas aninhadas.
• Formatação de blocos baseada em HTML: O conteúdo dos blocos é armazenado como strings HTML; formatações suportadas incluem negrito, itálico, tachado, links e texto colorido via tags HTML padrão.
• Blocos de grupo (group / delete_group): Um bloco de grupo atua como contêiner para blocos filhos; você cria o grupo, associa blocos filhos com group_id e pode deletar o grupo (e filhos) em uma operação.
• Tipos de blocos definidos: Inclui text, heading1/2/3, bullet_list, numbered_list, todo, quote, divider, code e group.

Como Usar o Parchment

1. Crie uma chave de API e envie requisições para a URL base da API: https://theparchment.app/functions/v1/api.
2. Liste ou crie estrutura: Comece listando coleções (list_collections), depois crie coleções e páginas usando as ações correspondentes (ex.: create_collection, create_page).
3. Escreva conteúdo de página usando blocos: Use append_blocks para adicionar blocos ao final de uma página existente, ou replace_blocks para reescrever toda a página em uma chamada.
4. Formate conteúdo com strings HTML: Forneça o content de cada bloco como uma string HTML usando tags suportadas (por exemplo, links via <a href="...">...</a>).
5. Organize com agrupamento quando necessário: Crie um bloco group primeiro, depois adicione blocos filhos que referenciem o grupo via group_id; remova conteúdo relacionado usando delete_group.

Casos de Uso

• Gere páginas a partir de dados estruturados: Use replace_blocks para escrever um layout completo de página (títulos, divisores, parágrafos, listas) a partir de uma única fonte de verdade.
• Construa logs de documentação “apenas append”: Use append_blocks para adicionar novas seções, atualizações ou entradas ao final de uma página sem perturbar o conteúdo anterior.
• Mantenha checklists hierárquicos: Crie blocos todo (itens de checkbox) e use blocos bullet_list/numbered_list aninhados com indent_level para representar subtarefas ou outlines.
• Gerencie blocos de conteúdo template em múltiplas páginas: Crie e renomeie páginas programaticamente, depois insira sequências consistentes de blocos (incluindo snippets de código via tipo code).
• Crie seções reutilizáveis via agrupamento: Use blocos de grupo para manter blocos relacionados juntos, e delete ou regenere uma seção inteira usando delete_group.

FAQ

• Qual endpoint a API do Parchment usa? A URL base da API é https://theparchment.app/functions/v1/api.

• Como autentico as requisições? Todas as requisições exigem um header x-api-key. Os exemplos da documentação mostram x-api-key: pmt_your_key.

• Qual a diferença entre append_blocks e replace_blocks? append_blocks adiciona novos blocos ao final da página sem substituir blocos existentes, enquanto replace_blocks deleta todos os blocos existentes e escreve os blocos fornecidos em ordem de array.

• O conteúdo dos blocos é texto simples ou HTML? O conteúdo dos blocos é armazenado como strings HTML; formatação usa tags HTML padrão (ex.: <strong>, <i>, <a> e <span style="color: ...">).

• Como funcionam listas aninhadas? Para bullet_list e numbered_list, os blocos suportam um campo indent_level (inteiro 0–4) para representar sub-listas aninhadas.

Alternativas

• Outras ferramentas de documentação ou base de conhecimento com API: Se você precisa gerar ou atualizar páginas estruturadas via código, procure ferramentas que ofereçam APIs de blocos/páginas semelhantes ao modelo coleção/página/bloco.
• Plataformas gerais de wiki/documentação: Elas podem suportar hierarquias de páginas e templating, mas o fluxo de trabalho e o modelo de dados podem diferir (especialmente se não usarem arrays de blocos).
• Abordagens genéricas de banco de dados para páginas: Ferramentas que renderizam conteúdo de um banco de dados em páginas podem se adequar quando o objetivo principal é organização estruturada, embora não forneçam as mesmas semânticas de append/substituir em nível de bloco.
• Geradores de sites estáticos locais: Para equipes confortáveis com geração em tempo de build, ferramentas de sites estáticos podem produzir páginas consistentes a partir de templates, mas tipicamente não suportam o mesmo modelo de edição interativa de páginas via API SaaS.