Skip to content

patrickkettner/manifestation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Manifestation

Kickstart your Progressive Web App journey with the information your site alredy contains. Manifestation downloads and scans the HTML of your site or app to try and build the most comprehensive Wep App Manifest possible.

Usage

npm install manifestation
const Manifestation = require('manifestation');

Manifestation({url: 'http://www.example.com'}, (err, manifest) => {

  if (err) throw err;

  console.log(manifest);

});

Fields include

  // outputs....
  // {
  //  "lang": "en",
  //  "dir": "ltr",
  //  "name": "Super Racer 2000",
  //  "description": "The ultimate futuristic racing game from the future!",
  //  "short_name": "Racer2K",
  //  "icons": [{
  //   "src": "icon/lowres.webp",
  //   "sizes": "64x64",
  //   "type": "image/webp"
  //    },{
  //      "src": "icon/lowres.png",
  //      "sizes": "64x64"
  //    }, {
  //      "src": "icon/hd_hi",
  //      "sizes": "128x128"
  //  }],
  //  "scope": "/racer/",
  //  "start_url": "/racer/start.html",
  //  "display": "fullscreen",
  //  "orientation": "landscape",
  //  "theme_color": "aliceblue",
  //  "background_color": "red",
  //  "related_applications": [{
  //        "platform": "play",
  //        "url": "https://play.google.com/store/apps/details?id=com.example.app1",
  //        "id": "com.example.app1"
  //    }, {
  //        "platform": "itunes",
  //        "url": "https://itunes.apple.com/app/example-app1/id123456789",
  //  }]
  //  "prefer_related_applications": false
  // }

});

About

have a W3C Web App Manifest automagically generated from its existing HTML

Resources

Stars

Watchers

Forks

Packages

No packages published