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.
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.
- 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 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-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 | Description |
|---|---|---|
| Web Components | web-components | React UI components including Markdown Editor, Contract Editor, Concerto Form and others |
| 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 |
| Projects | Description |
|---|---|
| Models | Accord Project Model Library |
| Template Library | Accord Project Template Library |
| Project | Repo |
|---|---|
| Documentation | techdocs |
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.
Using Accord Project? Add a README badge to let everyone know:
[](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.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!