feat: Add markdown to ADF (Atlassian Document Format) adapter module#1132
Open
codegen-sh[bot] wants to merge 2 commits intodevelopfrom
Open
feat: Add markdown to ADF (Atlassian Document Format) adapter module#1132codegen-sh[bot] wants to merge 2 commits intodevelopfrom
codegen-sh[bot] wants to merge 2 commits intodevelopfrom
Conversation
- Created comprehensive markdown to ADF converter in src/codegen/shared/markdown_adf/ - Supports all common markdown elements: headings, paragraphs, lists, code blocks, inline formatting - Includes type definitions for ADF document structure - Added comprehensive test suite with 20+ test cases - Added detailed documentation and usage examples - Added markdown>=3.4.0 dependency to pyproject.toml The adapter converts markdown text to Atlassian Document Format (ADF) JSON structure, which is used by Jira, Confluence, and other Atlassian products.
Codecov ReportAll modified and coverable lines are covered by tests ✅ ✅ All tests successful. No failed tests found. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds a comprehensive markdown to ADF (Atlassian Document Format) adapter module to the Codegen backend. The adapter converts standard Markdown text to ADF JSON structure, which is used by Atlassian products like Jira and Confluence.
What's Added
📦 New Module:
src/codegen/shared/markdown_adf/adapter.py- MainMarkdownToADFAdapterclass with conversion logicadf_types.py- Comprehensive type definitions for ADF document structure__init__.py- Module exports and public APIREADME.md- Detailed documentation with usage examples🧪 Comprehensive Test Suite
tests/shared/test_markdown_adf_adapter.py- 20+ test cases covering:📋 Dependencies
markdown>=3.4.0topyproject.tomlSupported Markdown Elements
# Headingheading**bold**strongmark*italic*emmark`code`codemark[link](url)linkmarkcodecodeBlock- itembulletList1. itemorderedList> quoteblockquote---ruleUsage Example
"""
adf_document = adapter.convert(markdown)
Returns properly structured ADF JSON