📜 Prose Module¶

The Prose Module is a sophisticated rich text content system designed to transform your written content into beautifully structured, navigable documents. This very description you're reading was created using the Prose Module itself—demonstrating its capability to handle complex formatting, hierarchical content, and enhanced readability features.

Core Features¶

Rich Text Content¶

At its heart, the Prose Module leverages Sanity's powerful block editor to provide a comprehensive rich text editing experience. Content creators can:

1. Format text with standard styling options
2. Create structured content with headings, paragraphs, lists, and more
3. Embed media and custom components seamlessly
4. Maintain consistent styling across all content
5. Embed images:

Automatic Table of Contents¶

One of the Prose Module's standout features is its intelligent table of contents generation. The system:

• Automatically scans all headings (H1-H6) within your content
• Generates a hierarchical navigation structure with proper indentation
• Provides three positioning options:
  • none: No table of contents displayed
  • left: Table of contents positioned on the left side
  • right: Table of contents positioned on the right side

Anchored Headings¶

Every heading in the Prose Module becomes a navigable anchor point:

• Automatic ID generation using URL-friendly slugs derived from heading text
• Permalink symbols (¶) that appear on hover for easy link sharing
• Smooth navigation when clicking table of contents links
• SEO-friendly structure for improved search engine indexing

Use Cases¶

This module is perfect for:

• Documentation (like this very page)
• Knowledge base entries
• Product descriptions with detailed specifications
• Tutorial content with step-by-step navigation
• Technical guides requiring structured navigation

The Prose Module transforms simple rich text into a professional, navigable document experience that enhances both content creation and reader engagement.