Parchment

Что такое Parchment?

Parchment — простое SaaS «альтернатива Notion», построенное вокруг создания и организации отдельных страниц и коллекций. Оно предлагает чистый интерфейс, концептуально ориентированный на организацию контента в страницы, где коллекции выступают в роли группировок.

Ключевой частью функциональности Parchment является программный доступ: вы можете управлять коллекциями, страницами и блоками внутри страниц через API. Это предназначено для пользователей, желающих структурированный контент страниц, который можно создавать, обновлять и экспортировать с помощью кода.

Ключевые возможности

• Коллекции и страницы (управление через API-действия): Создавайте, переименовывайте, перечисляйте и удаляйте коллекции и страницы, чтобы программно контролировать структуру контента.
• Блочный контент страниц: Страницы состоят из упорядоченных блоков (например, заголовки, текст, списки, код, разделители), которые можно добавлять или заменять.
• Полная перезапись страницы с replace_blocks: replace_blocks удаляет все существующие блоки на странице и записывает новый массив по порядку — полезно для генерации страницы с нуля.
• Инкрементальные правки с append_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-ключ и отправляйте запросы на базовый URL API: https://theparchment.app/functions/v1/api.
2. Перечислите или создайте структуру: Начните с перечисления коллекций (list_collections), затем создавайте коллекции и страницы соответствующими действиями (например, create_collection, create_page).
3. Записывайте контент страницы с помощью блоков: Используйте append_blocks для добавления блоков в конец существующей страницы или replace_blocks для полной перезаписи страницы одним вызовом.
4. Форматируйте контент HTML-строками: Указывайте content каждого блока как HTML-строку с поддерживаемыми тегами (например, ссылки через <a href="...">...</a>).
5. Организуйте с группировкой при необходимости: Сначала создайте блок group, затем добавьте дочерние блоки, ссылающиеся на группу через group_id; удалите связанный контент с помощью delete_group.

Сценарии использования

• Генерация страниц из структурированных данных: Используйте replace_blocks для записи полной разметки страницы (заголовки, разделители, абзацы, списки) из единого источника истины.
• Создание «только-добавление» логов документации: Используйте append_blocks для добавления новых разделов, обновлений или записей в конец страницы без нарушения предыдущего контента.
• Поддержка иерархических чек-листов: Создавайте блоки todo (элементы с чекбоксами) и используйте вложенные блоки bullet_list/numbered_list с indent_level для подзадач или схем.
• Управление шаблонными блоками контента на нескольких страницах: Программно создавайте и переименовывайте страницы, затем вставляйте последовательности блоков (включая фрагменты кода через тип code).
• Создание повторно используемых секций через группировку: Используйте групповые блоки для удержания связанных блоков вместе и удаляйте или регенерируйте целую секцию с помощью delete_group.

FAQ

• Какой эндпоинт использует API Parchment? Базовый URL API: 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.