Giter Club home page Giter Club logo

nuxt-crawler's Introduction

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

yarn add @yassidev/nuxt-crawler -D
# npm i @yassidev/nuxt-crawler -D

Usage

Within your nuxt.config add the following:

// nuxt.config

export default {
    buildModules: [
        '@yassidev/nuxt-crawler'
    ],

    crawler: {
        fields?: ((route: string, html: string, meta: MetaData) => Partial<MetaData>) | (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:

{
  "compilerOptions": {
    "types": [
      "@yassidev/nuxt-crawler"
    ]
  }
}

"compilerOptions": {

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.