https://github.com/mmorga/jsdex
Text indexer and Javascript library to access for non-public sites
https://github.com/mmorga/jsdex
Last synced: 4 months ago
JSON representation
Text indexer and Javascript library to access for non-public sites
- Host: GitHub
- URL: https://github.com/mmorga/jsdex
- Owner: mmorga
- License: mit
- Created: 2013-07-23T16:50:49.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-07-24T04:20:33.000Z (almost 13 years ago)
- Last Synced: 2023-04-13T07:51:09.582Z (about 3 years ago)
- Language: Ruby
- Size: 117 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Jsdex
Builds an text index of a set of files (such as the posts for a blog)
and provides a JavaScript library that allows searching of the index
on the browser to return search results.
This is intended for use in static site generators like Jekyll and
Octopress and for use in places where an external search site would
not have access to spider the generated site (such as within on an
intranet).
## Installation
Add this line to your application's Gemfile:
gem 'jsdex'
And then execute:
$ bundle
Or install it yourself as:
$ gem install jsdex
## Usage
TODO: Write usage instructions here
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request