antedate

Antedatar

Pre-renderiza sitios web estáticos con facilidad.

Antedate es una API y una CLI sencillas que utilizan Chrome Pupeteer para prerenderizar sitios web del lado del cliente. Automáticamente activa un servidor local y representa cada ruta proporcionada.

Instalar

 $ npm install antedate

Uso

Puede utilizar la API o la CLI.

 $ antedate render -r /home -r /about

 import antedate from 'antedate'

const routes = [ '/' , '/about' , '/contact' ] ;
const site = './site' ;

await antedate ( site , routes ) ;
// => [
//      { html: '....', route: '/', path: '/index.html' },
//      { html: '....', route: '/about', path: '/about.html' }
//      ...
// ]

await antedate ( site , routes , { headless : false , dirs : true } ) ;
// => [
//      { html: '....', route: '/', path: '/index.html' },
//      { html: '....', route: '/about', path: '/about/index.html' }
//      ...
// ] 

CLI

El módulo también viene con una CLI

  Description
    Pre-render the routes given

  Usage
    $ antedate render [options]

  Options
    -s, --selector    Wait for the following selector before rendering
    -w, --wait        MS to wait before saving page. Happens after selector wait
    -r, --route       Prerender the route specified
    -d, --dir         Directory containing the static site  (default .)
    -o, --output      Output directory  (default ./static)
    -h, --help        Displays this message

  Examples
    $ antedate render -r /home -r /about

API

antedate(raíz, rutas, opciones?)

Devuelve: Array

Devuelve una función de representación que, opcionalmente, aceptará un valor date como único argumento.

raíz

Tipo: String
Requerido: true

Ruta al directorio que contiene el sitio estático para prerenderizar. Antedate inicia automáticamente un servidor local.

rutas

Tipo: Array
Requerido: true

Conjunto de rutas a renderizar. La raíz / siempre se representa al final. Por ejemplo ['/about', '/contact', '/'] .

opta

Tipo: Object
Requerido: false

sin cabeza

Tipo: Boolean
Predeterminado: false

Ya sea para ejecutar el titiritero en modo sin cabeza.

selector

Tipo: String
Predeterminado: ``

Espere a que aparezca selector antes de renderizar el sitio. Por ejemplo, body.prerender .

esperar

Tipo: Number
Predeterminado: ``

Milisegundos antes de renderizar el sitio.

OBS: esto sucede después de la opción del selector si se proporcionan ambas.

guion

Tipo: Function
Predeterminado: ``

Una función de devolución de llamada para ejecutar en la página antes de que ocurra la representación.

decorador

Tipo: Function
Predeterminado: ``

Una función decoradora que le permite manipular la cadena HTML renderizada.

 await antedate ( site , routes , { decorator : html => html . toUpperCase ( ) } ) ; 

Crédito

La idea y la lógica se basan en el código de PWA de Luke Edwards. Vea la implementación original en build.js en @pwa/cli.

Licencia

Licencia MIT @ Terkel Gjervig