https://github.com/yassilah/nuxt-crawler

Automatic crawler & search for Nuxt SSG.
https://github.com/yassilah/nuxt-crawler

algolia crawler nuxt search ssg

Last synced: 7 days ago
JSON representation

Automatic crawler & search for Nuxt SSG.

• Host: GitHub
• URL: https://github.com/yassilah/nuxt-crawler
• Owner: yassilah
• Created: 2021-11-20T12:20:54.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-20T14:19:51.000Z (about 3 years ago)
• Last Synced: 2024-11-16T15:37:44.086Z (2 months ago)
• Topics: algolia, crawler, nuxt, search, ssg
• Language: JavaScript
• Homepage:
• Size: 333 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Features

Automatically crawl and store metadata about your Nuxt generated pages into your Algolia index. Should work with Nuxt 2, Nuxt Bridge & Nuxt 3 🔥.

# Install

```bash

yarn add @yassidev/nuxt-crawler -D

# npm i @yassidev/nuxt-crawler -D

```

# Usage

Within your `nuxt.config` add the following:

```ts

// nuxt.config

export default {

    buildModules: [

        '@yassidev/nuxt-crawler'

    ],

    crawler: {

        fields?: ((route: string, html: string, meta: MetaData) => Partial) | (keyof MetaData)[], // default: ['title', 'description']

        include?: ((route: string) => boolean) | (string | RegExp)[], // default: undefined

        apiKey: string, // required

        apiAdminKey: string, // required

        appId: string, // required

        indexName: string // required

    }

}

```

# Typescript

ForTypescript support, add the module within your `tsconfig.json`:

```json

{

  "compilerOptions": {

    "types": [

      "@yassidev/nuxt-crawler"

    ]

  }

}

```

  "compilerOptions": {