Giter Club home page Giter Club logo

algolia-indexer's Introduction

algolia-indexer

A NodeJS CLI tool to scan md and mdx files, parses frontmatter and updates the index on Algolia.

Configuration

In order for the tool to access Algolia you need to provide access keys and index name. This can be done either directly in the command line, via environment variables or by specifying the path to a .env file.

Environment variables names

ALGOLIA_APP_ID
ALGOLIA_INDEX
ALGOLIA_KEY

Passing keys via command line (not recommended):

npx algolia-indexer --algolia-app-id XXXXX --algolia-key XXXXX --index XXXXX --source ./

Usage examples

Using environment variables to access Algolia service:

npx algolia-indexer --source ./

Using a .env file to load env variables:

npx algolia-indexer --source ./

For all the available commands you can use the --help flag:

npx algolia-indexer --help

`

algolia-indexer's People

Contributors

abdelilah avatar

Stargazers

沐风(Mufeng) avatar

Watchers

 avatar

Forkers

huaguang-xinzhe

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.