jekyll-algolia 0.0.1 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -21
- data/lib/jekyll/algolia/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3612f58d87d7a769325fb89b2e76ea707278083a
|
|
4
|
+
data.tar.gz: 3a9e7d91f9183086831d2b276b7fd9e980fcd55a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ac705f398e1afc3db83611145a1070f713fffa6b5b51c34ef1dd8d257aad4aa3004dd2bc012234cbe88012cbe3cb594a32ceec1e108803c2566d8341cef536ac
|
|
7
|
+
data.tar.gz: 3b2728420b29fbef3e8cbf258c355e84760f46657b7cdcf76d9c1f48eec48cd2192e373f23b9fcdd5206747e3262c5c9a5adbae9b8c58b80ee08efc2522317e4
|
data/README.md
CHANGED
|
@@ -18,7 +18,7 @@ This will push the content of your Jekyll website to your Algolia index.
|
|
|
18
18
|
|
|
19
19
|
## Documentation
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
Full documentation can be found on
|
|
22
22
|
[https://community.algolia.com/jekyll-algolia/](https://community.algolia.com/jekyll-algolia/)
|
|
23
23
|
|
|
24
24
|
## Installation
|
|
@@ -32,7 +32,7 @@ section.
|
|
|
32
32
|
# Gemfile
|
|
33
33
|
|
|
34
34
|
group :jekyll_plugins do
|
|
35
|
-
gem 'jekyll-algolia'
|
|
35
|
+
gem 'jekyll-algolia', '~> 1.0'
|
|
36
36
|
end
|
|
37
37
|
```
|
|
38
38
|
|
|
@@ -44,8 +44,8 @@ You need to provide certain Algolia credentials for this plugin to *index* your
|
|
|
44
44
|
site.
|
|
45
45
|
|
|
46
46
|
*If you don't yet have an Algolia account, you can open a free [Community plan
|
|
47
|
-
here][
|
|
48
|
-
[your dashboard][
|
|
47
|
+
here][7]. Once signed in, you can get your credentials from
|
|
48
|
+
[your dashboard][8].*
|
|
49
49
|
|
|
50
50
|
Once you have your credentials, you should define your `application_id` and
|
|
51
51
|
`index_name` inside your `_config.yml` file like this:
|
|
@@ -71,7 +71,7 @@ Note that `ALGOLIA_API_KEY` should be set to your admin API key.
|
|
|
71
71
|
|
|
72
72
|
# Thanks
|
|
73
73
|
|
|
74
|
-
Thanks to [Anatoliy Yastreb][
|
|
74
|
+
Thanks to [Anatoliy Yastreb][9] for a [great tutorial][10] on creating Jekyll
|
|
75
75
|
plugins.
|
|
76
76
|
|
|
77
77
|
|
|
@@ -81,19 +81,7 @@ plugins.
|
|
|
81
81
|
[4]: https://codeclimate.com/github/algolia/jekyll-algolia/badges/gpa.svg
|
|
82
82
|
[5]: https://img.shields.io/badge/jekyll-%3E%3D%203.6.0-green.svg
|
|
83
83
|
[6]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg
|
|
84
|
-
[7]: https://
|
|
85
|
-
[8]:
|
|
86
|
-
[9]: https://
|
|
87
|
-
[10]: https://
|
|
88
|
-
[11]: http://www.methods.co.nz/asciidoc/
|
|
89
|
-
[12]: https://github.com/textile
|
|
90
|
-
[13]: https://www.algolia.com/doc/api-reference/api-methods/set-settings/?language=ruby#set-settings
|
|
91
|
-
[14]: https://www.algolia.com/doc/javascript
|
|
92
|
-
[15]: https://github.com/algolia/hyde
|
|
93
|
-
[16]: https://travis-ci.org/
|
|
94
|
-
[17]: https://travis-ci.org/
|
|
95
|
-
[18]: http://docs.travis-ci.com/user/environment-variables/
|
|
96
|
-
[19]: /docs/travis-settings.png
|
|
97
|
-
[20]: https://travis-ci.org
|
|
98
|
-
[21]: https://github.com/ayastreb/
|
|
99
|
-
[22]: https://ayastreb.me/writing-a-jekyll-plugin/
|
|
84
|
+
[7]: https://www.algolia.com/users/sign_up/hacker
|
|
85
|
+
[8]: https://www.algolia.com/licensing
|
|
86
|
+
[9]: https://github.com/ayastreb/
|
|
87
|
+
[10]: https://ayastreb.me/writing-a-jekyll-plugin/
|