.github/workflows        # Github actions set up here
crawler                  # Algolia crawler config
docs                     # static build files used by gh-pages
src                      # code for the @h2oai/makersaurus package
package-lock.json
package.json

After making a change to Makersaurus, it is important to understand what impact that change will have on newly created sites as well as larger sites that use more advanced features. The first step is to set up npm link in the root directory of this repo:

npm install
npm link

To test a local change on a newly created site, I recommend running through the create-new-project routine, pointing npx to the local version of Makersaurus. In a directory OUTSIDE of this repository, run:

npx --package=../path/to/makersarus/repo makersaurus test-app
cd test-app
npm install
npm start

The Algolia crawler runs once every 24 hours and is orchestrated in .github/workflows/index_docs.yml. To add a new site to the index, add the URL and sitemap to crawler/docsearch_scraper.json.