Skip to content

BREAKING CHANGE(*): remove markdown-pdf, docx & slate packages #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mttrbrts
Copy link
Member

@mttrbrts mttrbrts commented Apr 25, 2025

As per the 2025 plan this PR removes support for PDF, DOCX and Slate as transformation sources and targets. These projects were not maintained, and carry heavy-weight dependencies on third-party libraries.

For PDF & DOCS, it is recommended that the same capability is achieved using tools like Docling.

For Slate, client applications should create custom transforms for newer versions of Slate or other rich-text editors.

Changes

Deletes the following packages:

  • @accordproject/markdown-pdf
  • @accordproject/markdown-docx
  • @accordproject/markdown-slate

Flags

  • Note that the graph of transformations is now split into two separate subgraphs. This is expected, as the edge from templatemark to ciceromark is available via the draft command in the template-engine.
  • The deleted packages in npmjs will shortly be marked as archived too.
  • The build is failing for unrelated reasons. We should address that separately.

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to main from fork:branchname

@mttrbrts mttrbrts requested a review from dselman April 25, 2025 13:08
@mttrbrts mttrbrts marked this pull request as ready for review April 25, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant