Skip to content

mdangear/common-accord

 
 

Repository files navigation

Common Accord

This is a proposal on an implementation of common accord.

Install

Install NodeJS on your machine.

Clone this project to a folder on your e.g. /home//common-accord

Go into this folder and run the following command

npm install

Usage

To run the parser use the following command from the root of this project

node ./run.js <input> <output>

Example of ycombinator

node ./run.js ./doc/acme/angel-round/safe_robinson.md

or

node ./run.js ./doc/acme/angel-round/safe_robinson_v2_.md

Output will be int foder

./build/index.html

Principles

  • documents are managed as md files and follow the markdown spec
  • accord is an super set of markdown which enables the following features
    • import of documents
    • injection of variables
  • accord works as an preprocessor of mark down. This will follow the same approach as typescript as superset of javascript

Technology

Links

@ ./docs

About

Common Accord

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 54.9%
  • HTML 41.5%
  • GCC Machine Description 3.6%