Skip to content

Loads data from files and indexes it into Algolia. Useful for statically built sites made with Astro, Gatsby or any static site generator based on Markdown files.

Notifications You must be signed in to change notification settings

abdelilah/algolia-indexer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

`

About

Loads data from files and indexes it into Algolia. Useful for statically built sites made with Astro, Gatsby or any static site generator based on Markdown files.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published