Lyra's Astro Plugin
This package is a (still experimental) Lyra integration for Astro.
Usage
Configuring the Astro integration
// In `astro.config.mjs`
import lyra from '@lyrasearch/plugin-astro'
// https://astro.build/config
export default defineConfig({
integrations: [
lyra({
// We can generate more than one DB, with different configurations
mydb: {
// Required. Only pages matching this path regex will be indexed
pathMatcher: /blog\/[0-9]{4}\/[0-9]{2}\/[0-9]{2}\/.+$/,
// Optional. 'english' by default
language: 'spanish',
// Optional. ['body'] by default. Use it to constraint what is used to
// index a page.
contentSelectors: ['h1', 'main'],
},
}),
],
});
When running the astro build command, a new DB file will be persisted in the dist/assets directory. For the particular case of this example, it will be saved in the file dist/assets/lyraDB_mydb.json.
Using generated DBs in your pages
To use the generated DBs in your pages, you can include a script in your <head> section, as the following one:
<head>
<!-- Other stuff -->
<script>
// Astro will do the job of bundling everything for you
import { getLyraDB, search } from "@lyrasearch/plugin-astro/clientside"
// We load the DB that we generated at build time, this is an asynchronous
// operation, so we must either await, or rely on `.then` calls.
const db = await getLyraDB('mydb')
// Now we can search inside our DB. Of course, feel free to use it in more
// interesting ways.
console.log('Search Results')
console.log(search(db, { term: 'mySearchTerm' }))
</script>
</head>
NOTE: For now, this plugin only supports readonly DBs. This might change in the future if there's demand for it.
33 Dec 11, 2022
3 May 18, 2022
4 May 3, 2022
14 Jan 3, 2023
29 Dec 20, 2022
10 Dec 19, 2022
43 Dec 29, 2022
3 Jan 29, 2022
3 Mar 23, 2022
45 Jan 4, 2023
11 Nov 9, 2022
4 Jun 4, 2022
165 Dec 21, 2022
2 Sep 19, 2022
10 Dec 19, 2022
36 Dec 16, 2022
26 Jan 2, 2023
14 Dec 19, 2022
22 Dec 30, 2022