Offline indexing for documentation to make it searchable.

Overview

The Indexer is intended to be used as part of an information retrieval system, a search engine. It's responsible for extracting an inverted index from a Collection of Documents. The index maps terms t from the vocabulary set of the Collection to pairs (d, R(t, d)), where d is a Document identifier and R(t, d) is the relevance of term t to document d. How this index is used to produce an ordered list of Document links is left up to the Search Engine.

Install

• Clone this repository and cd into it.

• Download Bosh documentation from Cloud Foundry by issuing:

  go get -v github.com/cloudfoundry/docs-bosh

  Alternatively you can modify main.go to point to your documentation.

Index

make

If successful, this will yield an index.json file containing an inverted index of your documentation.

Test

make test