markdown-into-html v1.0.3

markdown-into-html

Transform Markdown to HTML

Features

• Transforms local files and files from URL
• Uses markdown-it to convert from Markdown to HTML
• Configurable, check list of options
• Supports:
  • tables
  • HTML tags
  • links
  • emojis
  • task lists
  • footnotes
  • abbreviations
  • definition lists
  • <ins> tags
  • superscripts
  • subscripts
  • qoutes, styling and more

Installation

With yarn:

yarn add markdown-to-html

With npm:

npm install markdown-to-html

Usage

const markdownIntoHtml = require('markdown-into-html')

// Local file
const html_code = await markdownIntoHtml({
    path: './myMarkdownFile.md',
})

// URL source
const html_code = await markdownIntoHtml({
    url: 'https://raw.githubusercontent.com/mateuszjanusz/markdown-into-html/master/README.md',
})

// Using options:
const html_code = await markdownIntoHtml({
    path: './myMarkdownFile.md',
    options: {
        emoji: false, // disabling emojis
    },
})

Properties

Options

By default all rules are enabled, but can be restricted by options.

License

MIT

References

• markdown-it