npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mark-parse

v2.1.0

Published

parses Markdown syntax and converts it into HTML

Downloads

20

Readme

Mark parse

Mark parse is a JavaScript module that allows you to parse Markdown text and convert it into HTML.

Installation

You can install the Make parse module using npm:

npm install mark-parse

Usage

Import the Make parse class into your JavaScript file:

import { MarkdownParser } from 'mark-parse';

Create an instance of the MarkdownParser class:

const parser = new MarkdownParser();

Parse Markdown text:

const markdown = '# Hello, World!';
const html = parser.parse(markdown);
console.log(html);

Options

The MarkdownParser constructor accepts an optional options parameter that allows you to customize the parsing behavior. The available options are:

  • parseList (default: true): Set to false to disable parsing of lists.
  • parseCodeBlock (default: true): Set to false to disable parsing of code blocks.
  • parseBlockQuote (default: true): Set to false to disable parsing of block quotes.
  • parseHeading (default: true): Set to false to disable parsing of headings.
  • parseInlineCode (default: true): Set to false to disable parsing of inline code.
  • parseHorizontalRule (default: true): Set to false to disable parsing of horizontal rules.
  • parseBold (default: true): Set to false to disable parsing of bold text.
  • parseItalic (default: true): Set to false to disable parsing of italic text.
  • parseUnderline (default: true): Set to false to disable parsing of underline text.
  • parseStrikethrough (default: true): Set to false to disable parsing of strikethrough text.
  • parseLink (default: true): Set to false to disable parsing of links.
  • parseImage (default: true): Set to false to disable parsing of images.

You can customize the parsing behavior by providing an options object when creating the MarkdownParser instance:

const options = {
  parseList: true,
  parseCodeBlock: true,
  parseBlockQuote: true,
  parseHeading: true,
  parseInlineCode: true,
  parseHorizontalRule: true,
  parseBold: true,
  parseItalic: true,
  parseUnderline: true,
  parseStrikethrough: true,
  parseLink: true,
  parseImage: true,
};

const parser = new MarkdownParser(options);

Example

Here's an example of parsing Markdown text and rendering the HTML output:

import { MarkdownParser } from 'markdown-parser';

const options = {
  parseHeading: false,
};

const parser = new MarkdownParser(options);

const markdown = '# Hello, World!';

const html = parser.parse(markdown);

console.log(html);

This output:

<p>Hello, World!</p>