Skip to content

adiwg/mdTools

Repository files navigation

mdTools

JavaScript tool for visualizing json-schemas, includes validator and support for the mdTranslator via the API.

The live application is rendering the mdJson-schemas.

Built using:

Developer Guide

This project uses the command line tool grunt to build the production version. At the moment, the dev parts appear to be a little broken but they have not been tested recently.

In order to build and deploy this application you should use the npm scripts rather than trying to do anything directly.

Install and Build

As usual, install npm dependencies first, then build the application.

  1. npm install
  2. npm run build

This will build the application into the docs/ directory, ready for production.

Deploy to GitHub Pages

Use the npm script:

npm run deploy

Build and Run with Docker

Build docker:

  1. docker build -t mdtools .
  2. docker run --rm -d -p 8043:8043 mdtools