Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
172 lines (98 sloc) 6.85 KB

zmarkdown Build Status Coverage Status

This repository forms the basis for zmarkdown, the JavaScript project intended to replace Python-ZMarkdown, the current Markdown engine powering Zeste de Savoir.

It is a collection of packages extending the remark processor and its MDAST syntax tree, rehype (for HTML processing) and textr (text transformation framework). It also provides MDAST to LaTeX compilation via rebber (and its plugins).

Install

Prerequisites

  • node >= 8
  • npm >= 6

Installation

  1. clone
  2. npm install
  3. npm run bootstrap

This project uses Jest for testing. It is recommended to install the Jest CLI tools globally, and run Jest in watch mode when developing.

  • npm install -g jest
  • jest --watch --notify (--notify sends desktop notifications when tests run)

Running the Tests

  • npm run test

    This script tests all packages.

  • npm run clean

    This script clears local dependencies, reinstalls the project and runs all tests.

Packages

License

MIT © Zeste de Savoir