@mattersmedia/article-json-to-apple-news

Render article JSON in the Apple News format

Stats

StarsIssuesVersionUpdatedCreatedSize
@mattersmedia/article-json-to-apple-news
1154.3.33 years ago3 years agoMinified + gzip package size for @mattersmedia/article-json-to-apple-news in KB

Readme

article-json-to-apple-news

Render article json in Apple News format

Build Status

Usage

npm install article-json-to-apple-news
const convertToAppleNews = require('article-json-to-apple-news');
const article = {
  title: 'Article Title',
  author: {
    name: 'John',
    href: 'http://example.com/john'
  },
  publishedDate: new Date('2016-02-04T14:00:00Z'),
  body: [
    {
      type: 'paragraph',
      children: [
        {
          type: 'text',
          content: 'This is the text and '
        },
        {
          type: 'text',
          bold: true,
          content: 'some bold text '
        },
        {
          type: 'text',
          href: 'http://example.com',
          content: 'some link'
        }
      ]
    },
    {
      type: 'embed',
      embedType: 'image',
      src: 'http://example/image.jpg',
      width: 300,
      height: 150
    }
  ]
};

console.log(convertToAppleNews(article, { identifier: 'article-identifier' }));
// {
//   article: <apple news article>,
//   bundlesToUrls: <object that maps bundle:// urls to http(s) urls>
// }

Body format

https://github.com/micnews/html-to-article-json#format

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.