Code Monkey home page Code Monkey logo

md-article's Introduction

md-article

Greenkeeper badge

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

  • remark instead of commonmark for all markdown helpers

License

MIT © Aleksandr Filatov

md-article's People

Contributors

greenkeeper[bot] avatar greybax avatar renovate-bot avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

md-article's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.