@atlaskit/editor-confluence-transformer
v13.1.4
Published
Editor Confluence Transformer
Readme
@atlaskit/editor-confluence-transformer
Editor Confluence Transformer for converting between ADF and Confluence XHTML formats.
Description
This package provides transformation utilities specifically designed for Confluence integration with the Atlassian Editor. It handles the conversion between ADF (Atlassian Document Format) and Confluence XHTML (CXHTML), enabling seamless content exchange between the editor and Confluence backend systems.
Key Features
Transformation Pipeline
- ADF to CXHTML: Convert editor content to Confluence-compatible XHTML
- CXHTML to ADF: Parse Confluence XHTML back into editor format
- Bidirectional Support: Reliable round-trip conversion capabilities
Processing Utilities
- Whitespace Handling: Intelligent whitespace collapse and normalization
- Content Wrapping: Proper content structure wrapping for Confluence
- Encoding Support: Character encoding and escaping for safe transport
- Language Mapping: Programming language name mapping between formats
Parsing and Encoding
- CXHTML Parser: Robust parsing of Confluence XHTML content
- Encoder: Safe encoding of content for Confluence storage
- Type Definitions: Comprehensive TypeScript types for transformation data
- Utility Functions: Helper functions for common transformation tasks
Examples
The package includes examples demonstrating:
- Basic CXHTML transformation workflows
- Integration patterns with Confluence systems
Team
Editor: Collaboration
