You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-9Lines changed: 4 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,17 @@
15
15
</a>
16
16
</p>
17
17
18
-
### Visit the [TemplateMark Dingus](https://templatemark-dingus.netlify.app)
19
-
20
18
## Introduction
21
19
22
-
A transformation and parsing framework for converting markdown content to HTML, Slate (for rich-text editing) and other structured document object models (DOMs).
20
+
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).
Top level repository (markdown-transform), with sub packages. Each sub-package is published as an independent npm module using `lerna`:
26
+
Top level repository (markdown-transform), with sub packages. Each sub-package is published as an independent npm module using `npm workspaces`:
29
27
*[markdown-cli](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-cli) : command line utilities
30
-
*[markdown-transform](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-transform) : High-level API to transform markdown into different formats
28
+
*[markdown-transform](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-transform) : High-level API to transform files into different formats
31
29
*[markdown-common](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-common) : converts between markdown strings and the CommonMark DOM
32
30
*[markdown-cicero](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-cicero) : converts between the CommonMark DOM and the CiceroMark DOM
33
31
*[markdown-template](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-template) : converts between JSON data + markdown strings and TemplateMark
@@ -37,7 +35,6 @@ Top level repository (markdown-transform), with sub packages. Each sub-package i
37
35
*[markdown-docx](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-docx) : converts a DOCX file to the CiceroMark DOM
38
36
*[markdown-it-cicero](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-it-cicero) : markdown-it plugin for contracts and CiceroMark
39
37
*[markdown-it-template](https://github.com/accordproject/markdown-transform/tree/main/packages/markdown-it-template) : markdown-it plugin for templates and TemplateMark
40
-
*[dingus](https://github.com/accordproject/markdown-transform/tree/main/packages/dingus) : published tool to edit markdown as HTML or a DOM
41
38
42
39
### CommonMark DOM
43
40
@@ -82,9 +79,7 @@ markus --help
82
79
83
80
### For developers
84
81
85
-
To install for development, in the project directory, you will need to first install [lerna](https://lerna.js.org):
86
82
```
87
-
npm install -g lerna@^3.20.2
88
83
npm install
89
84
```
90
85
@@ -94,7 +89,7 @@ Then run:
94
89
npm run test
95
90
```
96
91
97
-
Invokes _lerna_to run the test suite.
92
+
This command uses npm workspaces to run the tests for each package in the monorepo.
0 commit comments