ssr-to-html

Crawl a server rendered application and output html files

Usage no npm install needed!

<script type="module">
  import ssrToHtml from 'https://cdn.skypack.dev/ssr-to-html';
</script>

README


ssr-to-html
TypeScript Styled with prettier Build status NPM Version Downloads

Crawl a server rendered application and output html files.

Installation & Usage

Globally

npm

# Install
npm install ssr-to-html -g

# Use
ssr-to-html <options>

Locally

npm

# Install
npm install ssr-to-html

# Use with npm 7
npm exec -- ssr-to-html <options>

# Use with npm <6
npx ssr-to-html <options>

yarn

# Install
yarn install ssr-to-html

# Use
yarn ssr-to-html <options>

Examples (assuming globally installed)

$ ssr-to-html --out ./dist -- npm start

The above will execute the npm start command and wait for a server to begin listening. Once the server has started, we crawl the site starting from / and output .html files in the ./dist directory.

Options

Option Details
--out, -o The directory that the ".html" files will be written to.
--port The port of the server to connect to. This also sets "process.env.PORT". (default to a random available port)
--wait The total amount of time in ms to wait for the server to start on the specified port. Setting to 0 will disable this timeout. (default 30000)
--path, -p An additional path to crawl. (default will crawl from /)
--404 The path to the 404 page. (default /404/)
--help, -h Shows helpful information.

Code of Conduct

This project adheres to the eBay Code of Conduct. By participating in this project you agree to abide by its terms.