README.md

astro-portabletext

A flexible and customizable library for rendering Portable Text content in Astro projects.

🚀 Features

• Core components for common Portable Text elements.
• Customizable rendering using slots or your own components.
• Flexible control with the render function via usePortableText.
• Built with TypeScript support.

🎮 Demonstration

Jump in and see it in action:

📖 Resources

• Installation & usage docs: Read the full documentation
• TypeScript types: Type definitions
• Examples: Browse practical examples

Versions:

• Latest stable version (v0.11.0)
• Development branch

Sanity Integration

This library is officially recommended by Sanity for rendering Portable Text in Astro projects.

Helpful resources:

• Sanity Integration for Astro
• Guide: Building a Blog with Sanity and Astro

🙌 Contributing

We welcome contributions to improve astro-portabletext!

If you find a bug or have a feature request, please open an issue. If you'd like to contribute code, feel free to submit a pull request.

📄 License

This project is licensed under the ISC License.