feature(CannonicalURL) #22 Add support for cannonical URL (#27)

* feature(CannonicalURL) #22 Add support for cannonical URL as a new parameter

* feature(CannonicalURL) #22 Update readme with documentation

Co-authored-by: Ruslan Kazakov <[email protected]>

README.md

@@ -21,7 +21,7 @@ npm install ampify
 ```js
 const ampify = require('ampify');
 const html = '<YOUR_HTML_CONTENT>';
-const amp = ampify(html, {cwd: 'amp'});
+const amp = ampify(html, {cwd: 'amp'}, 'https://<your-canoncial-url>');
 console.log(amp); // Content of AMP HTML
 ```
 
@@ -36,6 +36,9 @@ console.log(amp); // Content of AMP HTML
 
 ### round
 
+## Canonical URL
+With the third parameter you can set the Cannonical URL, should be a full valid URL, please refer to [page discoverable](https://www.ampproject.org/docs/fundamentals/discovery)
+
 ### Enable images dimensions rounding
 
 - Type: `String`

index.js

@@ -5,7 +5,7 @@ const cheerio = require('cheerio');
 const sizeOf = require('image-size');
 const CleanCss = require('clean-css');
 
-module.exports = async (html, options) => {
+module.exports = (html, options, canonicalURL) => {
   const tags = {
     amp: ['img', 'video'],
   };
@@ -87,6 +87,10 @@ module.exports = async (html, options) => {
   $('head meta[charset="UTF-8"]').remove();
   $('head').prepend('<meta charset="utf-8">');
 
+  if (canonicalURL) {
+    $('head').append(`<link rel="canonical" href="${canonicalURL}">`);
+  }
+
   /* google analytics */
   $('script').each((index, element) => {
     const src = $(element).attr('src');

test/assert.js

@@ -1,6 +1,6 @@
 const ampify = require('../');
 
-module.exports = async (input, output, options) => {
-  const processed = await ampify(input, options);
+module.exports = (input, output, options, canonicalURL) => {
+  const processed = ampify(input, options, canonicalURL);
   expect(processed).toBe(output);
 };