-
Notifications
You must be signed in to change notification settings - Fork 10.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a how to add search to your website section #5272
Merged
Merged
Changes from 7 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
d492ab3
Add a how to add search to your website section
Khaledgarbaya bf485e4
Update adding-search.md
Khaledgarbaya 34a7f5e
Update doc-links.yaml
Khaledgarbaya 4631f6c
Update adding-search.md
Khaledgarbaya 8814718
Better restructuring
Khaledgarbaya 0814af1
Update doc-links.yaml
Khaledgarbaya 14616b0
Update adding-search.md
Khaledgarbaya a7d71bb
Address Changes
Khaledgarbaya ebe397e
Rewrite docs
Khaledgarbaya 3774a0e
Add the link before the links to stub articles
m-allanson 2749419
Tidy up
m-allanson bec961f
Merge branch 'master' into patch-2
m-allanson 15bc74b
Grammar/punctuation edits and some wording edits
shannonbux 1717368
Adding Headers
Khaledgarbaya bf1e4c3
Edits
m-allanson 87f15de
More headings
m-allanson d29b395
Minor edits
m-allanson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: "Adding search to your Gatsby website" | ||
--- | ||
|
||
There are few ways to approach adding search to your Gatsby-powered site: | ||
|
||
1. You can use libraries such as [elesticlunr][1] for offline search but doing so will require you to index at build time. Fortunately, this is achievable using the [gatsby-plugin-elasticlunr-search][2] plugin | ||
|
||
2. If you're building a website for your documentation, you can use the [Algolia docs][3] feature--it scrapes the dom and builds the search index automatically. After that, you'll need to implement your own [search ui][4]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Capitalize DOM and UI |
||
|
||
3. Use Algolia to collect the search index at build time and upload it to using [gatsby-plugin-algolia][5]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. delete "to" in "to using" |
||
|
||
|
||
[1]: https://www.npmjs.com/package/elasticlunr | ||
[2]: https://github.com/andrew-codes/gatsby-plugin-elasticlunr-search | ||
[3]: https://www.algolia.com/doc/ | ||
[4]: https://www.algolia.com/doc/paths/build-search-ui/ | ||
[5]: https://github.com/algolia/gatsby-plugin-algolia |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
...plugin. (needs a period to be consistent with the rest of this doc)