Skip to content
Library for Markdown Parsing and Transformation
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.travis chore(deploy) Enable alpha/beta release Oct 22, 2019
assets
packages
scripts
.gitignore
.travis.yml fix(script) Fix issue with download scripts once installed, refactor … Oct 26, 2019
CHARTER.md
CONTRIBUTING.md docs(CONTRIBUTING): fix broken coc link - I18 Oct 19, 2019
DEVELOPERS.md
HEADER
LICENSE
README.md fix(README): typo - I105 (#106) Oct 29, 2019
architecture.puml
jsdoc.json
lerna.json
package-lock.json chore(dep) Upgrade to Concerto 0.82.6 Nov 12, 2019
package.json

README.md

Markdown Transform

Build Status Coverage Status GitHub license downloads npm version Join the Accord Project Slack

Introduction

A transformation framework for converting markdown content to HTML, Slate (for rich-text editing) and other DOMs.

Architecture Diagram

Note: you can regenerate this diagram by visiting http://www.plantuml.com/plantuml/uml/ and pasting the contents of architecture.puml from 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:

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.15.0
npm install

Then run:

npm run test

Invokes lerna to run the test suite.


Accord Project Logo

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 Protocol 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-common npm version A framework for transforming markdown
markdown-slate npm version Transform markdown to/from CommonMark DOM
markdown-cli npm version CLI for markdown transformations.
markdown-cicero npm version Markdown extensions for contracts, clauses, variables etc.
markdown-html npm version Transform CiceroDOM to HTML

UI Components:

Projects Package name Version Description
Markdown Editor markdown-editor npm version WYSIWYG rich text web editor for markdown based on Slate.js
Cicero UI cicero-ui npm version React UI components for Cicero
Concerto UI concerto-ui npm version 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.

You can’t perform that action at this time.