Skip to content

Commit 70692e8

Browse files
committed
Add Google Custom Search Engine configuration documentation
1 parent 11a16fe commit 70692e8

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs/_docs/05-configuration.md

+22
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,28 @@ To use the Algolia search with GitHub Pages hosted sites follow [this deployment
533533
**Note:** The Jekyll Algolia plugin can be configured in several ways. Be sure to check out [their full documentation](https://community.algolia.com/jekyll-algolia/options.html "Algolia configuration") on how to exclude files and other valuable settings.
534534
{: .notice--info}
535535

536+
#### Google Custom Search Engine
537+
538+
Add a Google search box to your site.
539+
540+
1. Create a **New search engine** in [Google Custom Search Engine](https://cse.google.com/cse/all), give it an appropriate name and setup "Sites to search" to your liking.
541+
542+
2. Under **Look and feel** choose the "Results only" layout and a theme (*Minimalist* is a good choice to match the default look of the Minimal Mistakes).
543+
544+
![Google Custom Search Engine layout]({{ '/assets/images/google-custom-search-engine-layout.png' | relative_url }})
545+
546+
3. Select "Save & Get Code" and grab your search engine ID from the line that begins with `var cx = 'YOUR_SEARCH_ENGINE_ID'`.
547+
548+
4. Add your search engine ID to `_config.yml` like so:
549+
550+
```yaml
551+
google:
552+
search_engine_id: YOUR_SEARCH_ENGINE_ID
553+
```
554+
555+
**Note:** If your site is new and hasn't been indexed by Google yet, search will be incomplete and won't provide accurate results.
556+
{: .notice-info}
557+
536558
### SEO, Social Sharing, and Analytics Settings
537559

538560
All optional, but a good idea to take the time setting up to improve SEO and links shared from the site.
Loading

0 commit comments

Comments
 (0)