Skip to content

OliverTod/techdocs

 
 

Repository files navigation

Accord Project Logo

GitHub license Join the Accord Project Slack

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

Documentation

Ecosystem

Core libraries:

Projects Package name Version Description
Cicero cicero-core npm version Templates Core
cicero-cli npm version Cicero CLI
cicero-engine npm version Node.js VM based implementation of Accord Project Template Specification execution
cicero-server npm version Wraps the Cicero Engine and exposes it as a RESTful service
cicero-test npm version Testing support for Cicero based on cucumber
cicero-tools npm version Cicero Tools
generator-cicero-template npm version Code generator for a Cicero Template
Concerto concerto-core npm version Core Implementation for the Concerto Modeling Language
concerto-tools npm version Tools for the Concerto Modeling Language
concerto-cli npm version command-line interface for Concerto
Ergo ergo-cli npm version Ergo CLI
ergo-compiler npm version Ergo compiler
ergo-test npm version Ergo test
ergo-engine npm version Ergo engine
Markdown markdown-cicero npm version Markdown extensions for contracts, clauses, variables etc.
markdown-cli npm version CLI for markdown transformations
markdown-common npm version A framework for transforming markdown
markdown-docx npm version Transform between CiceroDOM and DOCX
markdown-html npm version Transform between CiceroDOM and HTML
markdown-it-cicero npm version CommonMark extension for CiceroMark for Clause, Variable, and ComputedVariable nodes
markdown-it-template npm version CommonMark extension for TemplateMark for Clause, Variable, and ComputedVariable nodes
markdown-pdf npm version Transform between CiceroDOM and PDF
markdown-slate npm version Transform markdown to/from CommonMark DOM
markdown-template npm version CommonMark extension for Clause, Variable, and Formula definitions
markdown-transform npm version 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 [email protected].

README Badge

Using Accord Project? Add a README badge to let everyone know: accord project

[![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](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.

About

Accord Project Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 64.1%
  • JavaScript 32.1%
  • Shell 3.6%
  • Handlebars 0.2%