A transformation and parsing framework for converting markdown content to HTML, 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:

• markdown-transform : High-level API to transform any supported format
• markdown-common : converts markdown strings to/from the CommonMark DOM
• markdown-cicero : converts CommonMark DOM to/from the CiceroMark DOM
• markdown-it-cicero : markdown-it plugin for contracts
• markdown-slate : converts CiceroMark DOM to/from the Slate DOM
• markdown-html : converts CiceroMark DOM to/from HTML
• markdown-pdf : converts a PDF file to/from a CiceroMark DOM
• markdown-docx : converts a DOCX file to a CiceroMark DOM
• markdown-cli : command line utilities
• markdown-template : converts JSON data and markdown strings to/from TemplateMark
• markdown-it-template : markdown-it plugin for templates

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 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 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

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

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

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.

• Accord Project
• Accord Project News
• Accord Project Blog
• Accord Project Slack
• Accord Project Technical Documentation
• Accord Project GitHub

• Getting Started with Accord Project
• Concepts and High-level Architecture
• How to use the Cicero Templating System
• How to Author Accord Project Templates
• Ergo Language Guide

Projects	Package name	Version	Description
Cicero	cicero-core		Templates Core
	cicero-cli		Cicero CLI
	cicero-engine		Node.js VM based implementation of Accord Protocol Template Specification execution
	cicero-server		Wraps the Cicero Engine and exposes it as a RESTful service
	cicero-test		Testing support for Cicero based on cucumber
	cicero-tools		Cicero Tools
	generator-cicero-template		Code generator for a Cicero Template
Concerto	concerto-core		Core Implementation for the Concerto Modeling Language
	concerto-tools		Tools for the Concerto Modeling Language
	concerto-cli		command-line interface for Concerto
Ergo	ergo-cli		Ergo CLI
	ergo-compiler		Ergo compiler
	ergo-test		Ergo test
	ergo-engine		Ergo engine
Markdown	markdown-common		A framework for transforming markdown
	markdown-slate		Transform markdown to/from CommonMark DOM
	markdown-cli		CLI for markdown transformations.
	markdown-cicero		Markdown extensions for contracts, clauses, variables etc.
	markdown-html		Transform CiceroDOM to HTML

Projects	Package name	Version	Description
Markdown Editor	markdown-editor		WYSIWYG rich text web editor for markdown based on Slate.js
Cicero UI	cicero-ui		React UI components for Cicero
Concerto UI	concerto-ui		Dynamic web forms generated from Concerto models

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.

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/)

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).

Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.