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.

Sign up for GitHub

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
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fd3f5a
BREAKING CHANGE(*): remove markdown-pdf, docx & slate packages
mttrbrts Apr 25, 2025
881f78f
fix(cli): reduce function coverage threshold
mttrbrts Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

## Introduction

A transformation and parsing framework for converting markdown content to HTML, PDF, DOCX, Slate (for rich-text editing) and other structured document object models (DOMs).
A transformation and parsing framework for converting markdown content to HTML and other structured document object models (DOMs).

![Transformations](./packages/markdown-transform/transformations.png)

Expand All @@ -29,10 +29,7 @@ Top level repository (markdown-transform), with sub packages. Each sub-package i
* [markdown-common](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-common) : converts between markdown strings and the CommonMark DOM
* [markdown-cicero](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-cicero) : converts between the CommonMark DOM and the CiceroMark DOM
* [markdown-template](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-template) : converts between JSON data + markdown strings and TemplateMark
* [markdown-slate](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-slate) : converts between the CiceroMark DOM and the Slate DOM
* [markdown-html](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-html) : converts between the CiceroMark DOM and HTML
* [markdown-pdf](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-pdf) : converts between a PDF file and the CiceroMark DOM
* [markdown-docx](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-docx) : converts a DOCX file to the CiceroMark DOM
* [markdown-it-cicero](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-it-cicero) : markdown-it plugin for contracts and CiceroMark
* [markdown-it-template](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-it-template) : markdown-it plugin for templates and TemplateMark

Expand All @@ -58,10 +55,6 @@ The TemplateMark DOM extends the CommonMark DOM, defining nodes for `ClauseDefin

The schema is defined here: https://models.accordproject.org/markdown/templatemark.html

### Slate DOM

The Slate DOM is defined by the [Slate](https://www.slatejs.org) HTML content-editable WYSIWYG editing framework.

## Installation

### For users
Expand Down
16 changes: 0 additions & 16 deletions architecture.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,24 +26,8 @@ note left of [CiceroMark DOM]
https://models.accordproject.org/ciceromark/ciceromark.html
end note

package "markdown-slate" {
[CiceroMark DOM] <-up-> [Slate DOM]
}

note left of [Slate DOM]
Slate is an HTML rich-text editor
https://www.slatejs.org
end note

package "markdown-html" {
[CiceroMark DOM] <-up-> [HTML String]
}

package "markdown-docx" {
[CiceroMark DOM] <-- [DOCX File]
}

package "markdown-pdf" {
[CiceroMark DOM] <-- [PDF File]
}
@enduml
Loading
Loading