A transformation framework for converting markdown content to HTML, Slate (for rich-text editing) and others DOMs.
Note: you can regenerate this diagram by visiting http://www.plantuml.com/plantuml/uml/ and pasting the contents of
architecture.pumlfrom this repository.
This mono-repo contains the following packages, where each package implements some transformations:
- 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 HTML
- markdown-cli : command line utilities
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/commonmark/markdown.html
The CiceroMark DOM extends the CommonMark DOM, defining nodes for Clause, Variable and ComputedVariable.
The schema is defined here: https://models.accordproject.org/cicero/dom.html
The Slate DOM is defined by the Slate HTML content-editable WYSIWYG editing framework.
In the project directory, you can run:
Invokes lerna to build all the markdown-* packages.
Invokes lerna to run the test suite.
This is a short reference guide, for a more full context, please refer to our CONTRIBUTING guide and information for DEVELOPERS.
- Fork project to your repository
- Clone to local machine with
git clone cdinto the directory- Run
npm install - Build in watch mode
npm run build:watch
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
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.
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.