Introduction
Technical Documentation for all Accord Project code. This site uses Docusaurus to generate static HTML.
The site is hosted at: https://docs.accordproject.org
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.
Installation
To build the documentation locally:
cd ./website
npm install
npm run start
If you want to re-generate the JSDoc API:
npm run build:api
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 Project 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-cicero |  |
Markdown extensions for contracts, clauses, variables etc. |
| markdown-cli |  |
CLI for markdown transformations | |
| markdown-common |  |
A framework for transforming markdown | |
| markdown-docx |  |
Transform between CiceroDOM and DOCX | |
| markdown-html |  |
Transform between CiceroDOM and HTML | |
| markdown-it-cicero |  |
CommonMark extension for CiceroMark for Clause, Variable, and ComputedVariable nodes | |
| markdown-it-template |  |
CommonMark extension for TemplateMark for Clause, Variable, and ComputedVariable nodes | |
| markdown-pdf |  |
Transform between CiceroDOM and PDF | |
| markdown-slate |  |
Transform markdown to/from CommonMark DOM | |
| markdown-template |  |
CommonMark extension for Clause, Variable, and Formula definitions | |
| markdown-transform |  |
High-level API to transform markdown into different formats | |
| dingus | Tool to edit markdown as HTML or a DOM |
UI Components:
| Projects | Package name | Description |
|---|---|---|
| Web Components | web-components | React UI components including Markdown Editor, Contract Editor, Concerto Form and others |
Template Editors:
| Projects | Description |
|---|---|
| Template Studio | Web UI for creating, editing and testing Accord Project templates |
| VSCode Extension | 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.
The Technical Steering Committee (TSC) may be emailed directly at tsc@accordproject.org.
README Badge
Using Accord Project? Add a README badge to let everyone know:
[](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).
Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See LF Projects Trademark Policy.