html-prerender

0.0.1 • Public • Published

How to use

Provide a list of URL to be compiled to HTML and saved to output Folder

Read example: test.js

Options

{
  // NOTE: Unless you are relying on asynchronously rendered content,
  // such as after an Ajax request, none of these options should be
  // necessary. All synchronous scripts are already executed before
  // capturing the page content.
 
  // Wait until a specific event is fired on the document.
  captureAfterDocumentEvent: 'custom-post-render-event',
  // This is how you would trigger this example event:
  // document.dispatchEvent(new Event('custom-post-render-event'))
 
  // Wait until a specific element is detected with
  // document.querySelector.
  captureAfterElementExists: '#content',
 
  // Wait until a number of milliseconds has passed after scripts
  // have been executed. It's important to note that this may
  // produce unreliable results when relying on network
  // communication or other operations with highly variable timing.
  captureAfterTime: 5000,
 
  // NOTE: You can even combine strategies if you like. For example,
  // if you only _sometimes_ want to wait for an event to fire, you
  // can create a timeout by combining captureAfterTime with
  // captureAfterDocumentEvent. When combining strategies, page
  // content will be captured after the first triggered strategy.
 
  // Instead of loudly failing on JS errors (the default), ignore them.
  ignoreJSErrors: true,
 
  // path of index file. By default it's index.html in static root.
  indexPath: path.resolve('/dist/path/to/index.html'),
 
  // Because PhantomJS occasionally runs into an intermittent issue,
  // we will retry a page capture up to 10 times by default. You may
  // raise or lower this limit if you wish.
  maxAttempts: 10,
 
  // Prevent PhantomJS from navigating away from the URL passed to it
  // and prevent loading embedded iframes (e.g. Disqus and Soundcloud
  // embeds), which are not ideal for SEO and may introduce JS errors.
  navigationLocked: true,
 
  // The options below expose configuration options for PhantomJS,
  // for the rare case that you need special settings for specific
  // systems or applications.
 
  // http://phantomjs.org/api/command-line.html#command-line-options
  phantomOptions: '--disk-cache=true',
 
  // http://phantomjs.org/api/webpage/property/settings.html
  phantomPageSettings: {
    loadImages: true
  },
 
  // http://phantomjs.org/api/webpage/property/viewport-size.html
  phantomPageViewportSize: {
    width: 1280,
    height: 800
  }
}

Credit

Inspired by https://github.com/chrisvfritz/prerender-spa-plugin

Package Sidebar

Install

npm i html-prerender

Weekly Downloads

2

Version

0.0.1

License

MIT

Unpacked Size

10.7 kB

Total Files

7

Last publish

Collaborators

  • dattran92