antedate

Vordatiert

Rendern Sie statische Websites ganz einfach vorab.

Antedate ist eine einfache API und CLI, die Chrome Pupeteer verwendet, um clientseitige Websites vorab zu rendern. Es startet automatisch einen lokalen Server und rendert jede bereitgestellte Route.

Installieren

 $ npm install antedate

Verwendung

Sie können entweder die API oder die CLI verwenden.

 $ 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

Das Modul verfügt außerdem über eine 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(root, Routen, Opts?)

Rückgabe: Array

Gibt eine Rendering-Funktion zurück, die optional einen date als einziges Argument akzeptiert.

Wurzel

Typ: String
Erforderlich: true

Pfad zum Verzeichnis, das die vorab zu rendernde statische Site enthält. Antedate startet automatisch einen lokalen Server.

Routen

Typ: Array
Erforderlich: true

Array von Routen, die gerendert werden sollen. Der Stamm / wird immer zuletzt gerendert. ZB ['/about', '/contact', '/'] .

optiert

Typ: Object
Erforderlich: false

kopflos

Typ: Boolean
Standard: false

Ob der Puppenspieler im Headless-Modus ausgeführt werden soll.

Wähler

Typ: String
Standard: ``

Warten Sie, bis selector angezeigt wird, bevor Sie die Site rendern. ZB body.prerender .

Warten

Typ: Number
Standard: ``

Millisekunden bis zum Rendern der Site.

OBS: Dies geschieht nach der Auswahloption, wenn beide bereitgestellt werden.

Skript

Typ: Function
Standard: ``

Eine Rückruffunktion, die auf der Seite ausgeführt wird, bevor das Rendern erfolgt.

Dekorateur

Typ: Function
Standard: ``

Eine Dekorationsfunktion, mit der Sie die gerenderte HTML-Zeichenfolge manipulieren können.

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

Kredit

Die Idee und Logik basiert auf Code von PWA von Luke Edwards. Siehe ursprüngliche Implementierung in build.js in @pwa/cli.

Lizenz

MIT-Lizenz @ Terkel Gjervig