Skip to content
This repository has been archived by the owner on Mar 21, 2018. It is now read-only.

Commit

Permalink
docs(readme): Add list of command line options
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelastic committed Jul 21, 2015
1 parent bd96080 commit 22fe658
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 22fe658

Please sign in to comment.