Markdown Transform
Introduction
A transformation framework for converting markdown content to HTML, Slate (for rich-text editing) and other DOMs.
Note: you can regenerate this diagram by visiting http://www.plantuml.com/plantuml/uml/ and pasting the contents of
architecture.pumlfrom this repository.
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-common : converts markdown strings to/from the CommonMark DOM
- markdown-cicero : converts CommonMark DOM to/from the CiceroMark DOM
- 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 a CiceroMark DOM
- markdown-docx : converts a DOCX file to a CiceroMark DOM
- markdown-cli : command line utilities
CommonMark DOM
The CommonMark DOM is a model for the elements of CommonMark, expressed as a Concerto schema, and serialized as a JSON graph.
The schema is defined here: https://models.accordproject.org/markdown/commonmark.html
CiceroMark DOM
The CiceroMark DOM extends the CommonMark DOM, defining nodes for Clause, Variable and ComputedVariable.
The schema is defined here: https://models.accordproject.org/markdown/ciceromark.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
- Accord Project
- Accord Project News
- Accord Project Blog
- Accord Project Slack
- Accord Project Technical Documentation
- Accord Project GitHub
Documentation
- 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
Ecosystem
Core libraries:
| 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 |
UI Components:
| 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 |
Template Editors:
| Projects | Cicero ver. | Description |
|---|---|---|
| Template Studio v1 | 0.13.4 | Web UI for creating, editing and testing Accord Project templates |
| Template Studio v2 | 0.13.4 | Web UI for creating, editing and testing Accord Project templates |
| VSCode Extension | 0.13.4 | VS Code extension for editing Cicero templates and Ergo logic |
Public templates and models:
| Projects | Description |
|---|---|
| Models | Accord Project Model Library |
| Template Library | Accord Project Template Library |
Documentation:
| Project | Repo |
|---|---|
| Documentation | techdocs |
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.
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).
Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.