Transform article HTML for Facebook Instant Articles, Apple News and Google AMP
HTML JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.babelrc
.gitignore
.npmignore
README.md
package.json

README.md

Distro.Mic

Transform article HTML for Facebook Instant Articles, Apple News and Google AMP.

Note, this module is designed to transform article body only, other elements of the article page like header, byline and custom stylesheets should be added separately for each format.

USAGE

Install using npm:

npm install distro-mic
var format = require('distro-mic').format;
var html = '<p>Article HTML</p>'

var output = format(html);

Output:

{
  amp: '<article><p>Article HTML</p></article>',
  instantArticle: '<article><p>Article HTML</p></article>',
  appleNews: {
    article: [{
      text: 'Article HTML\n',
      additions: [],
      inlineTextStyles: [],
      role: 'body',
      layout: 'bodyLayout'
    }],
    bundlesToUrls: {}
  }
}

API ENDPOINT

Distro is also available via API endpoint.

POST https://distro.mic.com/1.0/format

Post data:

Document HTML to transform

Query parameters:

output - one of apple-news, instant-article or amp. Return output for specified platform only. Optional.

LICENSE

MIT