├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitattributes
├── .gitignore
├── .npmignore
├── LICENSE
├── README.md
├── index.js
├── package-lock.json
├── package-scripts.js
├── package.json
└── src
└── gatsby-node.js
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | [
4 | "@babel/preset-env",
5 | {
6 | "targets": {
7 | "node": "current"
8 | }
9 | }
10 | ]
11 | ],
12 | "plugins": [
13 | "@babel/proposal-object-rest-spread"
14 | ]
15 | }
16 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | indent_style = space
5 | indent_size = 4
6 | charset = utf-8
7 | insert_final_newline = true
8 | end_of_line = lf
9 |
10 | [{package.json,.babelrc}]
11 | indent_style = space
12 | indent_size = 2
13 |
--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 | "env": {
3 | "es6": true,
4 | "node": true
5 | },
6 | "extends": "eslint:recommended",
7 | "rules": {
8 | "indent": [
9 | "error",
10 | 4
11 | ],
12 | "linebreak-style": [
13 | "error",
14 | "unix"
15 | ],
16 | "quotes": [
17 | "error",
18 | "backtick"
19 | ],
20 | "semi": [
21 | "error",
22 | "always"
23 | ]
24 | },
25 | "parserOptions": {
26 | "ecmaVersion": 2017,
27 | "ecmaFeatures": {
28 | "experimentalObjectRestSpread": true
29 | }
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto
2 |
3 | ## SOURCE CODE
4 | *.bat text eol=crlf
5 | *.coffee text
6 | *.css text
7 | *.htm text
8 | *.html text
9 | *.inc text
10 | *.ini text
11 | *.js text
12 | *.json text
13 | *.jsx text
14 | *.less text
15 | *.od text
16 | *.onlydata text
17 | *.php text
18 | *.pl text
19 | *.py text
20 | *.rb text
21 | *.sass text
22 | *.scm text
23 | *.scss text
24 | *.sh text eol=lf
25 | *.sql text
26 | *.styl text
27 | *.tag text
28 | *.ts text
29 | *.tsx text
30 | *.xml text
31 | *.xhtml text
32 |
33 | ## DOCKER
34 | *.dockerignore text
35 | Dockerfile text
36 |
37 | ## DOCUMENTATION
38 | *.markdown text
39 | *.md text
40 | *.mdwn text
41 | *.mdown text
42 | *.mkd text
43 | *.mkdn text
44 | *.mdtxt text
45 | *.mdtext text
46 | *.txt text
47 | AUTHORS text
48 | CHANGELOG text
49 | CHANGES text
50 | CONTRIBUTING text
51 | COPYING text
52 | copyright text
53 | *COPYRIGHT* text
54 | INSTALL text
55 | license text
56 | LICENSE text
57 | NEWS text
58 | readme text
59 | *README* text
60 | TODO text
61 |
62 | ## TEMPLATES
63 | *.dot text
64 | *.ejs text
65 | *.haml text
66 | *.handlebars text
67 | *.hbs text
68 | *.hbt text
69 | *.jade text
70 | *.latte text
71 | *.mustache text
72 | *.njk text
73 | *.phtml text
74 | *.tmpl text
75 | *.tpl text
76 | *.twig text
77 |
78 | ## LINTERS
79 | .csslintrc text
80 | .eslintrc text
81 | .htmlhintrc text
82 | .jscsrc text
83 | .jshintrc text
84 | .jshintignore text
85 | .stylelintrc text
86 |
87 | ## CONFIGS
88 | *.bowerrc text
89 | *.cnf text
90 | *.conf text
91 | *.config text
92 | .browserslistrc text
93 | .editorconfig text
94 | .gitattributes text
95 | .gitconfig text
96 | .gitignore text
97 | .htaccess text
98 | *.npmignore text
99 | *.yaml text
100 | *.yml text
101 | browserslist text
102 | Makefile text
103 | makefile text
104 |
105 | ## HEROKU
106 | Procfile text
107 | .slugignore text
108 |
109 | ## GRAPHICS
110 | *.ai binary
111 | *.bmp binary
112 | *.eps binary
113 | *.gif binary
114 | *.ico binary
115 | *.jng binary
116 | *.jp2 binary
117 | *.jpg binary
118 | *.jpeg binary
119 | *.jpx binary
120 | *.jxr binary
121 | *.pdf binary
122 | *.png binary
123 | *.psb binary
124 | *.psd binary
125 | *.svg text
126 | *.svgz binary
127 | *.tif binary
128 | *.tiff binary
129 | *.wbmp binary
130 | *.webp binary
131 |
132 | ## AUDIO
133 | *.kar binary
134 | *.m4a binary
135 | *.mid binary
136 | *.midi binary
137 | *.mp3 binary
138 | *.ogg binary
139 | *.ra binary
140 |
141 | ## VIDEO
142 | *.3gpp binary
143 | *.3gp binary
144 | *.as binary
145 | *.asf binary
146 | *.asx binary
147 | *.fla binary
148 | *.flv binary
149 | *.m4v binary
150 | *.mng binary
151 | *.mov binary
152 | *.mp4 binary
153 | *.mpeg binary
154 | *.mpg binary
155 | *.ogv binary
156 | *.swc binary
157 | *.swf binary
158 | *.webm binary
159 |
160 | ## ARCHIVES
161 | *.7z binary
162 | *.gz binary
163 | *.jar binary
164 | *.rar binary
165 | *.tar binary
166 | *.zip binary
167 |
168 | ## FONTS
169 | *.ttf binary
170 | *.eot binary
171 | *.otf binary
172 | *.woff binary
173 | *.woff2 binary
174 |
175 | ## EXECUTABLES
176 | *.exe binary
177 | *.pyc binary
178 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 |
3 | # Build artifacts
4 | /gatsby-node.js
5 |
6 | # Misc.
7 | .DS_Store
8 | *.log
9 |
10 | # IDE
11 | .idea/
12 | *.sublime*
13 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | src
2 | .babelrc
3 | .editorconfig
4 | .gitattributes
5 | package-scripts.js
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Andrew Smith
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://codeclimate.com/github/andrew-codes/gatsby-plugin-elasticlunr-search/maintainability)
2 | [](https://www.codacy.com/app/andrew-codes/gatsby-plugin-elasticlunr-search?utm_source=github.com&utm_medium=referral&utm_content=andrew-codes/gatsby-plugin-elasticlunr-search&utm_campaign=Badge_Grade)
3 |
4 | # Search Plugin for Gatsby
5 | This plugin enables search integration via elastic lunr. Content is indexed and then made available via graphql to rehydrate into an `elasticlunr` index. From there, queries can be made against this index to retrieve pages by their ID.
6 |
7 | # Getting Started
8 |
9 | Install the plugin via `npm install -D @andrew-codes/gatsby-plugin-elasticlunr-search`. See the [demo site repo](https://github.com/andrew-codes/gatsby-plugin-elasticlunr-search-demo) for more specific implementation details.
10 |
11 | Next, update your `gatsby-config.js` file to utilize the plugin.
12 |
13 | ## Setup in `gatsby-config`
14 | ```javascript
15 | module.exports = {
16 | plugins: [
17 | {
18 | resolve: `@andrew-codes/gatsby-plugin-elasticlunr-search`,
19 | options: {
20 | // Fields to index
21 | fields: [
22 | 'title',
23 | 'keywords',
24 | ],
25 | // How to resolve each field's value for a supported node type
26 | resolvers: {
27 | // For any node of type MarkdownRemark, list how to resolve the fields' values
28 | MarkdownRemark: {
29 | title: node => node.frontmatter.title,
30 | keywords: node => node.frontmatter.keywords,
31 | },
32 | },
33 | },
34 | },
35 | ],
36 | };
37 | ```
38 |
39 | ## Consuming in Your Site
40 | The serialized search index will be available via graphql. Once queried, a component can create a new elastic lunr index with the value retrieved from the graphql query. Search queries can be made against the hydrated search index. The results is an array of document IDs. The index can return the full document given a document ID
41 |
42 | ```javascript
43 | import React, {Component} from 'react';
44 | import {Index} from 'elasticlunr';
45 |
46 | // Graphql query used to retrieve the serialized search index.
47 | export const query = graphql`query
48 | SearchIndexExampleQuery {
49 | siteSearchIndex {
50 | index
51 | }
52 | }`;
53 |
54 | // Search component
55 | export default class Search extends Component {
56 | constructor(props) {
57 | super(props);
58 | this.state = {
59 | query: ``,
60 | results: [],
61 | };
62 | }
63 |
64 | render() {
65 | return (
66 |
67 |
68 |
69 | {this.state.results.map(page => (
70 | -
71 | {page.title}: {page.keywords.join(`,`)}
72 |
73 | ))}
74 |
75 |