Skip to content

Latest commit

 

History

History
executable file
·
92 lines (65 loc) · 4.39 KB

README.md

File metadata and controls

executable file
·
92 lines (65 loc) · 4.39 KB
Raw

markdown2html-pro

GitHub Status

Build Status Coverage Status MIT license

NPM Status

Build Status Code Climate Dependency Status Issue Stats Issue Stats Conventional Commits

A parser of Markdown and a render to html, written in typescript, that aims for preview-code , which is published as an extension on Visual Studio Code to preview Markdown, ReStructured Text, HTML, Jade, Pug or Mermaid files, Image's URI or CSS while editing them in VSCode.

It is built on top of markdown-it, a CommonMark markdown parser. You can use markdown2html-pro:

markdown2html-pro is the thing that parses package READMEs on http://www.npmjs.com. If you see a markdown parsing bug there, file an issue here!

[programmatically in NodeJS]: #Using this module in other modules

README

An extension to preview Markdown, ReStructured Text, HTML, Jade, Pug or Mermaid files, Image's URI or CSS while editing them in VSCode

Installation

npm install markdown2html-pro --save

Using this module in other modules

Here is a quick example of how this module can be used in other modules. The TypeScript Module Resolution Logic makes it quite easy. The file src/index.ts is a barrel that re-exports selected exports from other files. The package.json file contains main attribute that points to the generated lib/index.js file and typings attribute that points to the generated lib/index.d.ts file.

If you are planning to have code in multiple files (which is quite natural for a NodeJS module) that users can import, make sure you update src/index.ts file appropriately.

Now assuming you have published this amazing module to npm with the name markdown2html-pro, and installed it in the module in which you need it -

  • To use the Markdown2HtmlPro class in a TypeScript file -
import { Markdown2HtmlPro } from "markdown2html-pro";
const markdownContent = "";
const markdown2htmlPro = new Markdown2HtmlPro();
markdown2htmlPro.markdown2html(markdownContent);
  • To use the Markdown2HtmlPro class in a JavaScript file -
const Markdown2HtmlPro = require('markdown2html-pro').Markdown2HtmlPro;
const markdownContent = "";

const markdown2htmlPro = new Markdown2HtmlPro();
markdown2htmlPro.markdown2html(markdownContent);

Setting travis and coveralls badges

  1. Sign in to travis and activate the build for your project.
  2. Sign in to coveralls and activate the build for your project.
  3. Replace searKing/markdown2html-pro with your repo details like: "ospatil/generator-node-typescript".

Programmatic Usage

markdown2html-pro exports a single function. For basic use, that function takes a single argument: a string to convert.

var marky = require("markdown2html-pro")
var html = marky("# hello, I'm markdown")

Tests

npm install
npm test

Thanks to