portable-text-serialization
Portable TextをReact・Svelte・Vue・Astro・HTML・Markdown・プレーンテキストへレンダリング・シリアライズします。フロントエンドフレームワークでのPortable Textレンダリング実装、非標準ブロック型のカスタムシリアライザー構築、サーバーサイドでのHTML文字列変換、Markdownへの変換、プレーンテキスト抽出、またはマーク・ブロック・リスト・カスタム型のレンダリング問題をトラブルシュートする際に活用してください。
description の原文を見る
Render and serialize Portable Text to React, Svelte, Vue, Astro, HTML, Markdown, and plain text. Use when implementing Portable Text rendering in any frontend framework, building custom serializers for non-standard block types, converting Portable Text to HTML strings server-side, converting Portable Text to Markdown, extracting plain text from Portable Text, or troubleshooting rendering issues with marks, blocks, lists, or custom types.
SKILL.md 本文
Portable Text シリアライゼーション
@portabletext/* ライブラリファミリーを使用して、複数のフレームワーク間で Portable Text コンテンツをレンダリングします。各ライブラリは同じコンポーネントマッピングパターンに従います。PT ノードタイプをフレームワーク固有のレンダラーにマッピングする components オブジェクトを提供します。
Portable Text 構造 (クイックリファレンス)
PT はブロックの配列です。各ブロックは _type、オプションの style、children(スパン)、markDefs、listItem、および level を持ちます。
Root array
├── block (_type: "block")
│ ├── style: "normal" | "h1" | "h2" | "blockquote" | ...
│ ├── children: [span, span, ...]
│ │ └── span: { _type: "span", text: "...", marks: ["strong", "<markDefKey>"] }
│ ├── markDefs: [{ _key, _type: "link", href: "..." }, ...]
│ ├── listItem: "bullet" | "number" (optional)
│ └── level: 1, 2, 3... (optional, for nested lists)
├── custom block (_type: "image" | "code" | any custom type)
└── ...more blocks
マーク には 2 つの形式があります:
- デコレーター:
marks[]の文字列値("strong"、"em"、"underline"、"code"など) - アノテーション:
marks[]内のmarkDefs[]のエントリを参照するキー(リンク、内部参照など)
コンポーネントマッピングパターン(すべてのフレームワーク)
すべての @portabletext/* ライブラリは、以下のキーを持つ components オブジェクトを受け入れます:
| キー | レンダリング対象 | プロップ/データ |
|---|---|---|
types | カスタムブロック/インラインタイプ(image、code、CTA) | value(ブロックデータ) |
marks | デコレーター + アノテーション | children + value(マークデータ) |
block | ブロックスタイル(h1、normal、blockquote) | children |
list | リストラッパー(ul、ol) | children |
listItem | リストアイテム | children |
hardBreak | ブロック内の改行 | — |
フレームワーク固有のルール
お使いのフレームワークに対応するルールファイルをお読みください:
- React / Next.js:
rules/react.md—@portabletext/reactまたはnext-sanity - Svelte / SvelteKit:
rules/svelte.md—@portabletext/svelte - Vue / Nuxt:
rules/vue.md—@portabletext/vue - Astro:
rules/astro.md—astro-portabletext - HTML(サーバーサイド):
rules/html.md—@portabletext/to-html - Markdown:
rules/markdown.md—@portabletext/markdown - プレーンテキスト抽出:
rules/plain-text.md—@portabletext/toolkit
その他のコミュニティシリアライザー
以下は portabletext.org に記載されていますが、専用のルールファイルはありません:
| ターゲット | パッケージ |
|---|---|
| React Native | @portabletext/react-native-portabletext |
| React PDF | @portabletext/react-pdf-portabletext |
| Solid | solid-portabletext |
| Qwik | portabletext-qwik |
| Shopify Liquid | portable-text-to-liquid |
| PHP | sanity-php(SanityBlockContent クラス) |
| Python | portabletext-html |
| C# / .NET | dotnet-portable-text |
| Dart / Flutter | flutter_sanity_portable_text |
共通パターン(すべてのフレームワーク)
カスタムタイプは明示的なコンポーネントが必要
PT レンダラーはデフォルトで標準ブロックのみを処理します。カスタムタイプ(image、code、callToAction など)には明示的なコンポーネントマッピングが必要です。そうしないとレンダリングされません。
コンポーネントオブジェクトを安定に保つ
React/Vue では、components をレンダリング関数の外で定義するか、メモ化してください。毎回のレンダリング時に再作成すると、不要な再レンダリングが発生します。
欠落コンポーネントを適切に処理する
すべてのライブラリは onMissingComponent を受け入れて、未知のタイプが見つかった場合の動作を制御できます:
false— 警告を抑制- カスタム関数 — ログまたはレポート
GROQ で PT をクエリする
常にカスタムブロック内の参照を展開してください:
body[]{
...,
_type == "image" => {
...,
asset->
},
markDefs[]{
...,
_type == "internalLink" => {
...,
"slug": @.reference->slug.current
}
}
}
ライセンス: MIT(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- sanity-io
- ライセンス
- MIT
- 最終更新
- 不明
Source: https://github.com/sanity-io/agent-toolkit / ライセンス: MIT
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。