sharpetronics/jekyll-algolia
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #11 from DirtyF/patch-1

Browse Source 
Docs:  Test without cloning
This commit is contained in:
‮yrraC miT 2017-11-20 16:16:06 +01:00 committed by GitHub
commit 2a88acc858
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -10,8 +10,15 @@ Jekyll plugin to automatically index your content into Algolia.
## ⚠ Unreleased beta version ## ⚠ Unreleased beta version
This plugin is not **yet** released on Rubygems. If you want to try it, you This plugin is not **yet** released on Rubygems. If you want to try it either point to the develop branch of this repo:
should clone the repository and then update your `Gemfile` to point to the path
```yml
group :jekyll_plugins do
gem "jekyll-algolia", git: "https://github.com/algolia/jekyll-algolia", branch: "develop"
end
```
or clone the repository and then update your `Gemfile` to point to the path
on disk like this: on disk like this:
```yml ```yml
@ -25,7 +32,7 @@ Feedback very welcome!
## Usage ## Usage
```shell ```shell
$ jekyll algolia $ bundle exec jekyll algolia
``` ```
This will push the content of your Jekyll website to your Algolia index. This will push the content of your Jekyll website to your Algolia index.