Portable Text Conversion
SanityOfficialCreated by sanity
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides methods and specifications for transforming external content formats like HTML and Markdown into the Portable Text format used by Sanity. It covers the use of specific libraries for automated conversion, as well as the structural requirements for manually constructing Portable Text blocks, ensuring developers can programmatically ingest or migrate content into their Sanity projects.
What it does
- Converts Markdown to Portable Text using the markdownToPortableText function.
- Parses HTML into Portable Text blocks using the htmlToBlocks utility.
- Provides the structural specification for manual Portable Text block construction.
- Explains the use of _key, _type, and markDefs within the Portable Text schema.
- Details how to handle lists and nested content structures.
When to use it
- When migrating content from a legacy CMS to Sanity.
- When building automated pipelines to ingest HTML or Markdown into a Sanity dataset.
- When programmatically generating rich text content from external APIs or databases.
- When you need to ensure custom content structures adhere to the Portable Text specification.
Advantages
- Standardizes content ingestion across different source formats.
- Provides clear paths for both automated and manual content conversion.
- Ensures compatibility with Sanity's internal data requirements.
- Reduces manual effort during large-scale content migrations.
Usage examples
- “How do I convert a Markdown string to Portable Text?”
- The agent provides the implementation steps using the markdownToPortableText function from the @portabletext/markdown library.
- “What is the structure of a Portable Text block?”
- The agent returns the JSON schema for a block, including required fields like _type, _key, and the children array.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/sanity-io/portable-text-conversion/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip portable-text-conversion.zip -d .agents/skills
Documentation by sanity
Portable Text Conversion
Convert external content (HTML, Markdown) into Portable Text for Sanity. Three main approaches:
markdownToPortableText— Convert Markdown directly using@portabletext/markdown(recommended for Markdown)htmlToBlocks— Parse HTML into PT blocks using@portabletext/block-tools(for HTML migration)Manual construction — Build PT blocks directly from any source (APIs, databases, etc.)
Portable Text Specification
Understand the target format before converting. PT is an array of blocks:
[
{
"_type": "block",
"_key": "abc123",
"style": "normal",
"children": [
{"_type": "span", "_key": "def456", "text": "Hello ", "marks": []},
{"_type": "span", "_key": "ghi789", "text": "world", "marks": ["strong"]}
],
"markDefs": []
},
{
"_type": "block",
"_key": "jkl012",
"style": "h2",
"children": [
{"_type": "span", "_key": "mno345", "text": "A heading", "marks": []}
],
"markDefs": []
},
{
"_type": "image",
"_key": "pqr678",
"asset": {"_type": "reference", "_ref": "image-abc-200x200-png"}
}
]Key rules:
Every block and span needs
_key(unique within the array)_type: "block"is for text blocks; custom types use their own_typemarkDefsholds annotation data;markson spans referencemarkDefs[*]._keyor are decorator stringsLists use
listItem("bullet" | "number") andlevel(1, 2, 3...) on regular blocks
Conversion Rules
Read the rule file matching your source format:
Markdown → Portable Text:
rules/markdown-to-pt.md—@portabletext/markdownwithmarkdownToPortableText(recommended)HTML → Portable Text:
rules/html-to-pt.md—@portabletext/block-toolswithhtmlToBlocksManual PT Construction:
rules/manual-construction.md— build blocks programmatically from any source
Note:
@sanity/block-toolsis the legacy package name. Always use@portabletext/block-toolsfor new projects. The API is the same.
Files
- ATTRIBUTION.mdAdded by AutoGineer925 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md2.6 KiB
- rules/html-to-pt.md6.9 KiB
- rules/manual-construction.md4.9 KiB
- rules/markdown-to-pt.md5.5 KiB
rules/markdown-to-pt.md
title: Convert Markdown to Portable Text description: Convert Markdown content into Portable Text blocks using @portabletext/markdown tags: [portable-text, markdown, conversion, migration, import]
Convert Markdown to Portable Text
Use @portabletext/markdown for direct Markdown ↔ Portable Text conversion. This is the official library, part of the portabletext/editor monorepo.
npm install @portabletext/markdownBasic Usage
import {markdownToPortableText} from '@portabletext/markdown'
const blocks = markdownToPortableText('# Hello **world**')Output:
[{
"_type": "block",
"_key": "f4s8k2",
"style": "h1",
"children": [
{"_type": "span", "_key": "a9c3x1", "text": "Hello ", "marks": []},
{"_type": "span", "_key": "b7d2m5", "text": "world", "marks": ["strong"]}
],
"markDefs": []
}]Supported Markdown Features
Out of the box:
Headings (h1–h6)
Paragraphs
Bold, italic, inline code, strikethrough
Links
Blockquotes
Ordered and unordered lists (including nested)
Code blocks (fenced with language)
Horizontal rules
Images
Tables (GFM)
HTML blocks (configurable)
Custom Schema Mapping
Control how Markdown elements map to your PT schema. Define a schema with @portabletext/schema:
import {markdownToPortableText} from '@portabletext/markdown'
import {defineSchema, compileSchema} from '@portabletext/schema'
const schema = compileSchema(defineSchema({
styles: [{name: 'normal'}, {name: 'heading 1'}, {name: 'heading 2'}],
decorators: [{name: 'strong'}, {name: 'em'}],
annotations: [{name: 'link'}],
lists: [{name: 'bullet'}, {name: 'number'}],
}))
const blocks = markdownToPortableText(markdown, {
schema,
// Map Markdown heading levels to custom style names
block: {
h1: ({context}) => 'heading 1',
h2: ({context}) => 'heading 2',
},
})Using a Sanity Studio Schema
Use @portabletext/sanity-bridge to convert your Sanity block array schema:
import {markdownToPortableText} from '@portabletext/markdown'
import {sanitySchemaToPortableTextSchema} from '@portabletext/sanity-bridge'
// Convert a Sanity block array schema to a Portable Text schema
const schema = sanitySchemaToPortableTextSchema(sanityBlockArraySchema)
const blocks = markdownToPortableText(markdown, {schema})Custom Matchers
Matchers are top-level options (not nested under a matchers key). Each receives {context, value} where context.schema lets you validate against the schema:
const blocks = markdownToPortableText(markdown, {
// Block matchers — map Markdown block elements to PT styles
block: {
h1: ({context}) => {
const style = context.schema.styles.find((s) => s.name === 'heading 1')
return style?.name // Return undefined to skip
},
},
// Mark matchers — map Markdown inline elements to PT marks
marks: {
strong: ({context}) => 'strong',
},
// Type matchers — map Markdown elements to custom PT block types
types: {
table: ({context, value}) => {
const tableType = context.schema.blockObjects.find((obj) => obj.name === 'table')
if (!tableType) return undefined
return {
_type: 'table',
_key: context.keyGenerator(),
rows: value.rows,
headerRows: value.headerRows,
}
},
},
})Handling Inline HTML
Configure how inline HTML in Markdown is processed:
const blocks = markdownToPortableText(markdown, {
html: {
inline: 'text', // 'text' preserves as text, 'skip' removes
},
})Custom Key Generation
Provide your own key generator:
import {randomKey} from '@sanity/util/content'
const blocks = markdownToPortableText(markdown, {
keyGenerator: () => randomKey(12),
})Bidirectional: Also Converts PT → Markdown
The same package provides portableTextToMarkdown():
import {portableTextToMarkdown} from '@portabletext/markdown'
const markdown = portableTextToMarkdown(blocks)See the portable-text-serialization skill's rules/markdown.md for details on PT → Markdown.
Migration Example
import {markdownToPortableText} from '@portabletext/markdown'
import {createClient} from '@sanity/client'
import fs from 'fs'
import path from 'path'
import matter from 'gray-matter'
const client = createClient({projectId: 'xxx', dataset: 'production', token: '...'})
// Import a directory of Markdown files
const mdFiles = fs.readdirSync('./content').filter(f => f.endsWith('.md'))
for (const file of mdFiles) {
const raw = fs.readFileSync(path.join('./content', file), 'utf-8')
const {data: frontmatter, content} = matter(raw)
const body = markdownToPortableText(content)
await client.createOrReplace({
_id: `post-${path.basename(file, '.md')}`,
_type: 'post',
title: frontmatter.title,
body,
})
}When to Use htmlToBlocks Instead
Use @portabletext/block-tools (htmlToBlocks) when:
Your source is HTML, not Markdown
You need custom deserializer rules for non-standard HTML elements
You're migrating from a CMS that exports HTML (WordPress, Contentful, etc.)
You need to handle complex HTML structures (tables with merged cells, nested divs, etc.)
For Markdown sources, @portabletext/markdown is simpler and more direct.
Reference
Part of the portabletext/editor monorepo
Uses markdown-it internally
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- sanity
- Publisher
- Sanity (Official)
- Source
- sanity-io/agent-toolkit · skills/portable-text-conversion · commit 3ed3a14
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by sanity or Sanity.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download portable-text-conversion.zip