Markdown Transform

Visit the TemplateMark Dingus

Introduction

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

Structure of the Code Repository

Top level repository (markdown-transform), with sub packages. Each sub-package is published as an independent npm module using lerna:

markdown-cli : command line utilities
markdown-transform : High-level API to transform markdown into different formats
markdown-common : converts between markdown strings and the CommonMark DOM
markdown-cicero : converts between the CommonMark DOM and the CiceroMark DOM
markdown-template : converts between JSON data + markdown strings and TemplateMark
markdown-slate : converts between the CiceroMark DOM and the Slate DOM
markdown-html : converts between the CiceroMark DOM and HTML
markdown-pdf : converts between a PDF file and the CiceroMark DOM
markdown-docx : converts a DOCX file to the CiceroMark DOM
markdown-it-cicero : markdown-it plugin for contracts and CiceroMark
markdown-it-template : markdown-it plugin for templates and TemplateMark
dingus : published tool to edit markdown as HTML or a DOM

CommonMark DOM

The CommonMark DOM is a model for the elements of CommonMark (the specification for markdown text), expressed as a Concerto schema, and serialized as a JSON graph.

The schema is defined here: https://models.accordproject.org/markdown/[email protected]

CiceroMark DOM

CiceroMark defines markdown documents with embedded clauses, where each clause is an instance of a template, specified using TemplateMark.

The CiceroMark DOM extends the CommonMark DOM, defining nodes for Clause, Variable and Formula etc.

The schema is defined here: https://models.accordproject.org/markdown/[email protected]

TemplateMark DOM

TemplateMark defines markdown documents with syntax for embedded variables, optional blocks, formulas etc. It is used to define Accord Project templates.

The TemplateMark DOM extends the CommonMark DOM, defining nodes for ClauseDefinition, VariableDefinition and ForumulaDefinition etc.

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

Slate DOM

The Slate DOM is defined by the Slate HTML content-editable WYSIWYG editing framework.

Installation

For users

To install the command-line interface:

npm install -g @accordproject/markdown-cli

This will install the markus command-line for markdown transform. To get command-line help:

markus --help

For developers

To install for development, in the project directory, you will need to first install lerna:

npm install -g lerna@^3.20.2
npm install

Then run:

npm run test

Invokes lerna to run the test suite.

Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the Linux Foundation. The technical charter for the Accord Project can be found here.

Learn More About Accord Project

Overview

Documentation

Contributing

The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.

Find out what’s coming on our blog.

Join the Accord Project Technology Working Group Slack channel to get involved!

For code contributions, read our CONTRIBUTING guide and information for DEVELOPERS.

README Badge

Using Accord Project? Add a README badge to let everyone know:

[![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/)

License

Accord Project source code files are made available under the Apache License, Version 2.0. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).

cxiaohuiyang / markdown-transform Goto Github PK