readme.md

html-to-amp

Small module to transform html pages to amp, using html-to-article-json & article-json-to-amp

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install html-to-amp --save

Usage

import setupHtmlToAmp from 'html-to-amp';
const htmlToAmp = setupHtmlToAmp();

const html = `
  <p>beep booop</p>
  // if width and/or height is missing of an image the width & height will be
  //  read from the image (since width & height is required in AMP)
  <img src="http://example.com/image.jpg" />

  // youtube, twitter, instagram, facebook, vine & custom embeds are
  //  (through html-to-article-json) supported
  <blockquote class="twitter-tweet" data-lang="en"><p lang="en" dir="ltr"><a href="https://t.co/kt1c5RWajI">https://t.co/kt1c5RWajI</a>’s <a href="https://twitter.com/david_bjorklund">@david_bjorklund</a> published 2 node modules to convert HTML snippets to <a href="https://twitter.com/AMPhtml">@amphtml</a><a href="https://t.co/yB5KMDijh6">https://t.co/yB5KMDijh6</a></p>&mdash; Malte Ubl (@cramforce) <a href="https://twitter.com/cramforce/status/697485294531145730">February 10, 2016</a></blockquote> <script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>
`;

// can be used with callbacks
htmlToAmp(html, (err, amp) => {
  if (err) {
    throw err;
  }
  // do something with it
});

// when second argument is ommited a promise is returned
htmlToAmp(html).then(amp => {
  // do something with it
});

Tests

npm install
npm test

Dependencies

• article-json-to-amp: Render JSON formatted article in the AMP format
• bluebird: Full featured Promises/A+ implementation with exceptionally good performance
• html-to-article-json: Converting HTML to article-json
• request-image-size: Detect image dimensions via request.

Dev Dependencies

• ava: Futuristic test runner 🚀
• babel-cli: Babel command line.
• babel-core: Babel compiler core.
• babel-preset-es2015: Babel preset for all es2015 plugins.
• nyc: the Istanbul command line interface
• package-json-to-readme: Generate a README.md from package.json contents
• semistandard: All the goodness of feross/standard with semicolons sprinkled on top.
• snazzy: Format JavaScript Standard Style as Stylish (i.e. snazzy) output

License

MIT

Generated by package-json-to-readme