diff --git a/docs/assets/images/dry-run-a51601eead2c4a160f88b1594682f25e.gif b/docs/assets/images/dry-run-a51601eead2c4a160f88b1594682f25e.gif new file mode 100644 index 0000000..5b50fa5 Binary files /dev/null and b/docs/assets/images/dry-run-a51601eead2c4a160f88b1594682f25e.gif differ diff --git a/docs/assets/images/getting-started-ff88ef93194e04687d7f08079df54ce9.gif b/docs/assets/images/getting-started-ff88ef93194e04687d7f08079df54ce9.gif new file mode 100644 index 0000000..9e5ea40 Binary files /dev/null and b/docs/assets/images/getting-started-ff88ef93194e04687d7f08079df54ce9.gif differ diff --git a/docs/getting-started.html b/docs/getting-started.html index 2c9bef4..4521adc 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -193,7 +193,7 @@

Getting started

Welcome to jekyll-algolia

-

jekyll-algolia is a Jekyll plugin that lets you index all your content in an +

jekyll-algolia is a Jekyll plugin that lets you push all your content in an Algolia index.

Requirements

You’ll need:

@@ -240,7 +240,7 @@ following command:

write access to your index so will be able to push new data. This is also why you have to set it on the command line and not in the _config.yml file: you want to keep this key secret and not commit it to your versioning system.

- +

jekyll algolia command example

Note that the method can be simplified to jekyll algolia by using an alternative way of loading the API key and using rubygems-bundler.

Front-end

diff --git a/docs/how-it-works.html b/docs/how-it-works.html index 000b6e1..9d93eb4 100644 --- a/docs/how-it-works.html +++ b/docs/how-it-works.html @@ -241,5 +241,5 @@ relevance of the search results.

an estimate of how many records will actually be pushed. The plugin tries to be smart and consume as less operations as possible, but you can always run it in --dry-run mode to better understand what it would do.

- +

jekyll algolia dry run example

\ No newline at end of file