antedate

Antidate

Pré-rendez facilement les sites Web statiques.

Antedate est une API et une CLI simples qui utilisent Chrome Pupeteer pour pré-afficher des sites Web côté client. Il démarre automatiquement un serveur local et restitue chaque itinéraire fourni.

Installer

 $ npm install antedate

Usage

Vous pouvez utiliser l'API ou 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

Le module est également livré avec une 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

antidate (racine, routes, opts ?)

Renvoie : Array

Renvoie une fonction de rendu qui acceptera éventuellement une valeur date comme seul argument.

racine

Type : String
Obligatoire : true

Chemin d'accès au répertoire contenant le site statique à pré-rendu. Antedate démarre automatiquement un serveur local.

itinéraires

Type : Array
Obligatoire : true

Tableau d'itinéraires à restituer. La racine / est toujours rendue en dernier. Par exemple ['/about', '/contact', '/'] .

opte

Type : Object
Obligatoire : false

sans tête

Type : Boolean
Par défaut : false

Que ce soit pour exécuter le marionnettiste en mode sans tête.

sélecteur

Type : String
Par défaut : ``

Attendez que selector apparaisse avant de rendre le site. Par exemple, body.prerender .

attendez

Type : Number
Par défaut : ``

Millisecondes avant le rendu du site.

OBS : cela se produit après l'option de sélection si les deux sont fournies.

scénario

Type : Function
Par défaut : ``

Une fonction de rappel à exécuter sur la page avant le rendu.

décorateur

Type : Function
Par défaut : ``

Une fonction de décorateur qui vous permet de manipuler la chaîne HTML rendue.

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

Crédit

L'idée et la logique sont basées sur le code de PWA de Luke Edwards. Voir l'implémentation originale dans build.js dans @pwa/cli.

Licence

Licence MIT @ Terkel Gjervig