AsciiBinder Search Plugin

What is this?

This is a small plugin that generates a data.json which contains the content and title of each page and puts it in each distro. This file is indexed and searched with search template client side. This plugin provides a default search template that is ready to use, but if you want you can use your own search template. See the instructions below.

Installation instructions

1. Make sure you have a working installation of python3

2. Create a virtualenv

    python3 -m venv <name of virtualenv>
   

3. Activate the virtualenv

    source <name of virtualenv>/bin/activate
   

4. Install

    pip install git+https://github.com/smitthakkar96/ascii_binder_search_plugin
   

Usage

1. After your build your site, generate the data.json

    ascii_binder_search
   

2. Download, and optionally customize search.html or other assets present in static directory

3. Add the search to the documentation site

    ascii_binder_search -s <path_to_static_directory>
   

Everything that would be present in static folder will be copied to thier respective paths Please consider using _javascripts/<js_file> for javascripts and _stylesheets/<js_file> for stylesheets in your search.html

screenshot