Skip to content

TheDataMine/docs-scraper2

Repository files navigation

Purdue University


Website: https://the-examples-book.com


docs-scraper

This is a fork of the docs-scraper for Meilisearch. Meilisearch is a fantastic search solution that makes it very easy to integrate powerful and fast search capabilities into your website or project. docs-scraper is an associated project that makes it easy to scrape your website and update the search index. We've forked this repository to ensure that breaking changes aren't made suddenly and without warning.

Run

To run this script, the following 2 environment variables are required to be set:

  • MEILISEARCH_API_KEY
  • MEILISEARCH_HOST_URL

MEILISEARCH_API_KEY is your Meilisearch instance's API key, and MEILISEARCH_HOST_URL is the URL where the Meilisearch instance is running. If running locally, the easiest way to set this up is to create a .env file with the required information. docs-scraper will automatically use the information therein.

MEILISEARCH_API_KEY=<api_key>
MEILISEARCH_HOST_URL=<host_url>

First, clone the repository.

git clone git@github.com:TheDataMine/docs-scraper.git

Then, to update the search index, run the following.

cd docs-scraper
pipenv install
pipenv run ./docs-scraper the-examples-book.config.json

Congratulations, the search index is now up-to-date.

— # —

About

Fork of https://github.com/meilisearch/docs-scraper to automatically update search index for the-examples-book.com

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published