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

markdown-ast

v0.3.0

Published

Markdown AST parser

Downloads

8,749

Readme

markdown-ast

npm Build status Coverage status Bundle size Install size Code style: Prettier Donate

Fork of snarkdown that returns an array of AST nodes, instead of an HTML string.

TypeScript support included!

import md from 'markdown-ast'

const ast = md(code)

The goal is to support Github-style markdown. Please file an issue if you run into any inconsistencies.

 

Notable behavior

  • Node locations are not tracked.
  • No HTML parsing. Embedded HTML is plain text.
  • Single \n chars are removed from the start/end of plain text.

 

Node types

Every node has a type property equal to one of these:

  • bold: __text__ or **text**
  • border: 3+ character sequence of [*-_] w/ optional spaces between
  • break: \n\n or \r\n\r\n or \s\s\n or \s\s\r\n
  • codeBlock: triple backticks or 4-spaces/tab indented
  • codeSpan: inline backticks
  • image: ![alt](url) or ![alt][key] or just ![altAsKey]
  • italic: _text_ or *text*
  • link: [text](url) or [text][key] or just [textAsKey]
  • linkDef: [key]: url
  • list: markdown w/ [-+*]|\d+[\.\)] prefix
  • quote: markdown w/ > prefix
  • strike: ~~text~~
  • text
  • title: markdown w/ #{1,6} prefix or underlined w/ 3+ =|- symbols

Available properties are defined here.

 

Block nodes

"Block nodes" have a block property containing any nested nodes. Blocks are auto-closed when their parent block is closed (unless the nested block is already closed, of course).

Some nodes (which may not be blocks) auto-close all open blocks. These include border, break, list, quote, and title nodes.

"Inline blocks" can be used anywhere in the document. These include bold, codeSpan, image, italic, link, and strike nodes.

"Recursive blocks" use their own parsing context to process any nested nodes. These include list, quote, and title nodes.