2 releases
0.1.5 | Aug 11, 2023 |
---|---|
0.1.4 | Jul 2, 2023 |
115KB
105 lines
auto-pagefind
Use Pagefind with any live server.
Insallation
Install the modules required for the program.
cargo install spider_cli
cargo install pagefind
cargo install auto-pagefind
Getting Started
-
Start the dev or prod instance on port 3000 and run
auto-pagefind
at the root directory of your next application to create your search index's and output the content into thepublic
folder. -
Optional: Add
data-pagefind-meta="url[href]"
on your metahrefLang
links example:<link rel="alternate" hrefLang="en" href="https://a11ywatch.com/blog/version-your-proto-definitions-for-stablity" data-pagefind-meta="url[href]"/>
to replace the location of the links. -
Setup pagefind client loading in the your project. You can use the pagefind-react component with
npm install pagefind-react --save
for a drop in ready search.
Options
Some optional options below.
auto-pagefind --help
Pagefind for next.js non output export applications. Fully crawl and index your app in one command.
Usage: auto-pagefind [OPTIONS]
Options:
-d, --download-dir <DOWNLOAD_DIR> The download directory for storing the static.html files
-u, --url <URL> The website url
-h, --help Print help
-V, --version Print version
CSP
You need to add the following header if csp is enabled 'wasm-unsafe-eval'
.
Dependencies
~1.1–1.7MB
~32K SLoC