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

docs(readme): Add list of command line options

Browse Source
This commit is contained in:
Pixelastic 2015-07-21 22:16:37 +02:00
parent bd960807fd
commit 22fe6583cc
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -134,10 +134,25 @@ class AlgoliaSearchRecordExtractor
end
```
## Command line
Here is the list of command line options you can pass to the `jekyll algolia
push` command:
| Flag | Description |
| ---- | ----- |
| `--config ./_config.yml` | You can here specify the config file to use. Default is `_config.yml` |
| `--future` | With this flag, the command will also index posts with a future date |
| `--limit_posts 10` | Limits the number of posts to parse and index |
| `--drafts` | Index drafts in the `_drafts` folder as well |
| `--dry-run` or `-n` | Do a dry run, do not actually push anything to your index |
| `--verbose` | Display more information about what is going to be indexed |
## Dependencies
The `algoliasearch-jekyll` plugin works form versions of Jekyll starting from
2.5, with a version of Ruby of at least 2.0.
The `algoliasearch-jekyll` plugin works for versions of Jekyll starting from
2.5, with a version of Ruby of at least 2.0. You also need
[Bundler](http://bundler.io/) to easily add the gem as a dependency to Jekyll.
## Searching