Skip to content

thimmy687/Simple-MD2HTML

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple Markdown parser

Document CII Best Practices

by Ricardo Krause

This is a JavaScript/Typescript markdown to HTML parser with Visual Studio Code

Preconditions

Installation

  • Download or clone the project from Github
  • Run $ npm install to install necessary packages

Usage

  • Go to the directory of from the project
  • Start the node server with $ npm start

Tests

  • Start the Test-Runner to see the unit test results in the console
$ npm test

Documentation

  • One part of the documentation is available as docx and pdf dirctly on Github

  • For additional information you can see it as esdoc

  • or enter $ npm docs to open the readme online

Contribution

  • Open the project with Visual Studio Code
  • Start the TypeScript-Compiler with [strg]+[shift]+[b]
  • Start the node server $ npm run dev
  • Open the browser on localhost:3000

Liecence

no licence