npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-pagefind

v0.3.0

Published

A Vite plugin for easily integrating pagefind into Vite based projects.

Downloads

946

Readme

vite-plugin-pagefind

A Vite plugin for easily integrating pagefind into Vite based projects.

Features

  • Ensures pagefind is present during development.
  • Ensures pagefind can be safely used through dynamic imports in conjunction with Vite.

Why?

Read about the reasoning for this plugin here: https://hugokorte.pages.dev/articles/pagefind-with-vite

Installation

Install from npm using your preferred package manager:

pnpm add -D pagefind vite-plugin-pagefind

Usage

  1. Add the plugin to in vite.config.ts:
import { defineConfig } from "vite";
import pagefind from "vite-plugin-pagefind";

export default defineConfig({
	plugins: [pagefind()],
});

You can pass the options to the plugin directly in your Vite configuration:

import { defineConfig } from "vite";
import pagefind from "vite-plugin-pagefind";

export default defineConfig({
	plugins: [
		pagefind({
			site: "<BUILD_DIR>",
			assets_dir: "<ASSETS_DIR>",
			pagefind_dir: "<PAGEFIND_DIR>",
			build_command: "<BUILD_COMMAND>",
			dev_strategy: "<DEV_STRATEGY>",
		}),
	],
});

Note: If you decide to use an inline config, you would still need to add the --site flag to your pagefind command.

Note: If your framework does not have a vite.config consider consulting the framework documentation to see how to add a Vite plugin.

  1. Add the post build command to your package.json:
{
	"scripts": {
		"build": "vite build && pagefind"
	}
}
  1. If you didn't pass the configuration options to the plugin, you can use the pagefind.json file to configure the plugin, as shown:
{
	"site": "<BUILD_DIR>",
	"vite_plugin_pagefind": {
		"assets_dir": "<ASSETS_DIR>",
		"pagefind_dir": "<PAGEFIND_DIR>",
		"build_command": "<BUILD_COMMAND>",
		"dev_strategy": "<DEV_STRATEGY>"
	}
}

If for some reason you decide to define your configuration in both the file and the Vite configuration, the file will take precedence over the inline Vite configuration.

Note: vite-plugin-pagefind currently only supports .json files, more are planned be supported in the future.

Config

site

The directory where your build output lives, this is required for both pagefind and this plugin.

assets_dir

The directory where the static assets are located relative to the project's root as specified in the Vite config.

default: 'public'

pagefind_dir

The directory part of the URL you use to import the pagefind script on your site. For example, if you use /pagefind/pagefind.js, the pagefind_dir is pagefind. If you use /search/static/pagefind/pagefind.js, the pagefind_dir is search/static/pagefind.

default: 'pagefind'

build_command

The command to build and index the project.

default: 'npm run build'

dev_strategy

The indexing strategy used during development:

  • "eager": Build and index the app every time the development server starts
  • "lazy": Build and index the app only if the pagefind bundle isn't present already

default: 'lazy'

Types

Apart from the plugin, this package also exposes the types from pagefind as well as extending them by providing an additional Pagefind type:

import type { Pagefind } from "vite-plugin-pagefind/types";

const pagefind: Pagefind = await import("/pagefind/pagefind.js");

Pagefind

For further questions regarding Pagefind itself you can refer to the official docs.

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.