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

md-article

v1.1.0

Published

Extract data from markdown article

Downloads

17

Readme

md-article

NPM version Build Status Coveralls Status Dependency Status

Extract data from your markdown article

Install

npm install --save md-article

Usage

import extract from 'md-article';

const input = `
# title

_24 june 2016_

#tag1 #tag2 #tag3;

desc

content1

content2`;

const article = extract(input, 'D MMMM YYYY', 'en');
article.title.text;    // title
article.date.text;     // 24 june 2016
article.tags.text;     // tag1 tag2 tag3
article.content.html;  // <p>desc</p>
                       // <p>content1</p>
                       // <p>content2</p>

API

extract(input, dateFormat, dateLocale)

Return object { title, date, tags, content }.

I hope that all fields have self-explanatory names. Anyway, tags and content should be explained further: desc — paragrapgh with elements like #tag1 #tag2;, content input without title, tags and date. All the fields are objects with such fields:

  • title, content: text and html
  • tags: list, text and html
  • date: text, html, unix and moment

Also everything in returned mdast object node, see MDAST.

input

Required
Type: String

Markdown string.

dateFormat

Required
Type: String

Momentjs format for date, e.g. D MMMM YYYY.

dateLocale

Required
Type: String

One of 83 available in momentjs locales, e.g. en or fr.

Related

  • md-title — get title from markdown article
  • md-date — get date from markdown article
  • md-tags — get tags from markdown article
  • md-content — get content from markdown article

Roadmap

  • [x] remark instead of commonmark for all markdown helpers

License

MIT © Aleksandr Filatov