docsearch.js

DocSearch

The easiest way to add search to your documentation. For free.

Check out our website to add an outstanding search to your documentation.

Table of Contents

• Introduction
• Setup
• Customization
• Development workflow
  • Local example
  • Local build
  • Documentation website
  • MacOS

Introduction

We're scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn't always easy to find the information we need.

Not blaming anyone here. Building a good search for a documentation is a complex challenge. We happen to have a lot of experience doing that, and we want to share it with the world. For free.

Just submit the form on the website and we'll get back to you with what you need to integrate your new search into your website.

1. We'll crawl your documentation pages,
2. We'll configure your search experience,
3. You'll need to add a bit of JavaScript and CSS code to your website.

Setup

Once we've crawled your documentation website we'll send you the credentials you need to add the following code snippet to your website:

<link rel="stylesheet" href="//cdn.jsdelivr.net/docsearch.js/0/docsearch.min.css" />
<script type="text/javascript" src="//cdn.jsdelivr.net/docsearch.js/0/docsearch.min.js"></script>
<script type="text/javascript">
docsearch({
  apiKey: '<API_KEY>',
  indexName: '<INDEX_NAME>',
  inputSelector: '<YOUR_INPUT_DOM_SELECTOR>'
});
</script>

Customization

The default colorscheme is blue and gray:

To update the colors to suit your website, you just need to override a few colors. Here is an example of a CSS file that you can use as a basis and that sets white and purples colors.

/* Bottom border of each suggestion */
.algolia-docsearch-suggestion {
  border-bottom-color: #3A3DD1;
}
/* Main category headers */
.algolia-docsearch-suggestion--category-header {
  background-color: #4B54DE;
}
/* Highlighted search terms */
.algolia-docsearch-suggestion--highlight {
  color: #3A33D1;
}
/* Highligted search terms in the main category headers */
.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight  {
  background-color: #4D47D5;
}
/* Currently selected suggestion */
.aa-cursor .algolia-docsearch-suggestion--content {
  color: #272296;
}
.aa-cursor .algolia-docsearch-suggestion {
  background: #EBEBFB;
}

/* For bigger screens, when displaying results in two columns */
@media (min-width: 768px) {
  /* Bottom border of each suggestion */
  .algolia-docsearch-suggestion {
    border-bottom-color: #7671df;
  }
  /* Left column, with secondary category header */
  .algolia-docsearch-suggestion--subcategory-column {
    border-right-color: #7671df;
    background-color: #F2F2FF;
    color: #4E4726;
  }
}

Advanced users can also clone the repository, edit the _variables.scss file and re-build the CSS file using npm run build:css.

Development workflow

Local example

We use a simple documentation example website as a way to develop the docsearch library.

Requirements:

• Node.js
• npm@2

npm run dev
# open http://localhost:8080

Local build

• npm run build:js: will transpile all the JavaScript files inside ./dist. We build a bundled (and bundled + minified) version for CDNs and another one for npm
• npm run build:css will convert the SCSS to CSS, along with sourcemaps and minified versions
• npm run build:docs will create the ./docs/documentation.md file from the README.md file, to be displayed on the website.
• npm run build will run all three previous commands

Documentation website

This is the Jekyll instance running at https://community.algolia.com/docsearch.

Requirements:

• Ruby
• Bundler

npm run dev:docs
# open http://localhost:4000/docsearch/
# Note that it also implicitly starts another server on localhost:8080, to load
the bundled JavaScript from

MacOS

If you are using brew and you had brew install openssl, you may need to configure the build path of eventmachine with

bundle config build.eventmachine --with-cppflags=-I$(brew --prefix openssl)/include

Changelog

1.0.0 (2015-12-24)

Bug Fixes

• isSubCategoryHeader: ensure we hide the content of the left column if this flag is not set (0e04ce4), closes #47