antedate

Mendahului

Pra-render situs web statis dengan mudah.

Antedate adalah API dan CLI sederhana yang menggunakan dalang Chrome untuk melakukan pra-render situs web sisi klien. Secara otomatis menjalankan server lokal dan merender setiap rute yang disediakan.

Memasang

 $ npm install antedate

Penggunaan

Anda bisa menggunakan API atau 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

Modul ini juga dilengkapi dengan 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, rute, opts?)

Pengembalian: Array

Mengembalikan fungsi rendering yang secara opsional akan menerima nilai date sebagai satu-satunya argumennya.

akar

Jenis: String
Diperlukan: true

Jalur ke direktori yang berisi situs statis untuk dirender sebelumnya. Antedate secara otomatis memulai server lokal.

rute

Jenis: Array
Diperlukan: true

Berbagai rute yang akan dirender. Root / selalu dirender terakhir. Misalnya ['/about', '/contact', '/'] .

memilih

Jenis: Object
Diperlukan: false

tanpa kepala

Jenis: Boolean
Bawaan: false

Apakah akan menjalankan dalang dalam mode tanpa kepala.

pemilih

Jenis: String
Bawaan: ``

Tunggu hingga selector muncul sebelum merender situs. Misalnya body.prerender .

Tunggu

Jenis: Number
Bawaan: ``

Milidetik sebelum merender situs.

OBS: Ini terjadi setelah opsi pemilih jika keduanya disediakan.

naskah

Jenis: Function
Bawaan: ``

Fungsi panggilan balik untuk dijalankan pada halaman sebelum rendering terjadi.

penghias

Jenis: Function
Bawaan: ``

Fungsi dekorator yang memungkinkan Anda memanipulasi string HTML yang dirender.

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

Kredit

Ide dan logikanya didasarkan pada kode dari PWA oleh Luke Edwards. Lihat implementasi asli di build.js di @pwa/cli.

Lisensi

Lisensi MIT @ Terkel Gjervig