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.
packages Publish Feb 4, 2019
.babelrc
.editorconfig Add editorconfig Jun 5, 2017
.eslintignore Update dependencies Jul 19, 2018
.eslintrc.json
.gitignore fix gitignore Jul 21, 2017
.hound.yml Give hound eslint config Mar 19, 2017
.travis.yml chore(ci): Use lockfiles for CI Feb 4, 2019
CODE_OF_CONDUCT.md
LICENSE-MIT Improve root README Jun 4, 2017
README.md
lerna.json meta: adapt lerna setup to 3.x Nov 19, 2018
package-lock.json
package.json

README.md

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