npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@chiffon/prerender-webpack-plugin

v0.0.3

Published

Prerender for web applications built with Preact

Downloads

11

Readme

@chiffon/prerender-webpack-plugin

Prerender your index.html via JavaScript, allowing for easy customization.

Installation

npm:

npm install --save-dev @chiffon/prerender-webpack-plugin

yarn:

yarn add --dev @chiffon/prerender-webpack-plugin

Usage

In your webpack config:

const PrerenderWebpackPlugin = require('@chiffon/prerender-webpack-plugin');

module.exports = {
  ...
  plugins: [
    // instead of 'HtmlWebpackPlugin'
    new PrerenderWebpackPlugin({
      filename: 'index.html',
      template: path.resolve(__dirname, 'src', 'index.js'),
    }),
    ...
  ]
};

@chiffon/prerender-webpack-plugin will pass the output file paths like JavaScript and CSS to your function in index.js, which must return a string:

// index.js
import React from 'react'
import ReactDOM from 'react-dom/server'
import App from './App.js'

function defaultTemplate({ css, js }) {
  // First we render the outside parts of html as static string (e.g. head, body)
  // Next, we render the web app root as html (e.g. <App />) and
  // inject this into the outside parts via dangerouslySetInnerHTML because
  // we only need React to hydrate the root element.
  return `<!DOCTYPE html>
  ${ReactDOM.renderToStaticMarkup(
    <html>
      <head>
        <meta charset="UTF-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <title>My Web App</title>
        {css &&
          css.map(cssResourceUrl => (
            <link
              href={`${__webpack_public_path__}${cssResourceUrl}`}
              rel="stylesheet"
            />
          ))}
        {js &&
          js.map(jsResourceUrl => (
            <script
              src={`${__webpack_public_path__}${jsResourceUrl}`}
              nomodule
              defer
            />
          ))}
      </head>
      <body>
        <div
          id="root"
          dangerouslySetInnerHTML={{ __html: ReactDOM.renderToString(<App />) }}
        />
      </body>
    </html>,
  )}`
}

export default defaultTemplate

FAQ

What is prerendering?

Single Page Applications (SPA) like those made from create-react-app, vue-cli and similar tools require JavaScript to run before creating the components in the HTML.

Prerendering is generating the HTML during compile time (e.g. webpack build), so that users see some content before JavaScript is downloaded and parsed.

Why prerender?

Prerendering results in better perceived performance as users see the content earlier.

There are some Search Engine Optimisations (SEO) benefits too as search engine crawlers are better with plain HTML than SPAs.

What are the downsides to prerendering?

Even though your content is prerendered, user interactions like clicks and key presses may not trigger as JavaScript has not executed yet. If you have large JavaScript files, this may not be ideal.

Certain applications such as internal apps may not benefit from faster content.

References and Further Reading