Skip to content

Contributor Tooling

CΔƒtΔƒlin BuruianΔƒ edited this page Apr 14, 2020 · 1 revision

We have open-sourced some of the libraries which we use to programmatically manipulate our content. If you think any of these might help you work with the curriculum, feel free to check them out.

Most notably, here is the compiler & parser package that is used to break down insights into Abstract Syntax Trees and build them back into markdown or other formats.

  • an X parser transforms content from format X to an AST (abstract syntax tree)
  • an X compiler transforms content from an AST to format X

This package is furthermore divided into multiple packages:

  • @enkidevs/curriculum-compiler-json

Compile parsed curriculum AST into a more user-friendly JSON

  • @enkidevs/curriculum-compiler-react

Compile parsed curriculum AST into a React tree

  • @enkidevs/curriculum-compiler-

Compile parsed curriculum AST into a string

  • @enkidevs/curriculum-helpers

Helpers for processing the curriculum

  • @enkidevs/curriculum-parser-

Parse curriculum json into an

  • @enkidevs/curriculum-parser-

Parse curriculum markdown string into an AST

Secondly, we packaged a bunch of hacky scripts and parsing utilities into the Curriculum Tools package. The scope of this library is to provide an easy-to-use interface for progressing through the content and analysing or manipulating it. Note that bugs might be found within it as we seldom update it and we plan on deprecating it soon.

Clone this wiki locally