File Listing

## IndexHtml [![Gem Version](https://badge.fury.io/rb/index_html.svg)](http://badge.fury.io/rb/index_html) [![Dependency Status](https://gemnasium.com/agilecreativity/index_html.png)](https://gemnasium.com/agilecreativity/index_html) [![Code Climate](https://codeclimate.com/github/agilecreativity/index_html.png)](https://codeclimate.com/github/agilecreativity/index_html) Quickly generate the index.html files based on your simple criteria. ### Installation Add this line to your application's Gemfile: gem 'index_html' And then execute: $ bundle Or install it yourself as: $ gem install index_html ### Usage Say you have lots of ebook files (pdf, epub, or mobi) and you have properly named them with something like [ebook_renamer][]. Now that you have the good data, if you like to create a quick index to all of the files that have the specific word 'Android' in the title you could perhap try something like the following: ```sh gem install index_html cd ~/Dropbox/ebooks/ index_html generate --base-dir . \ --exts epub pdf mobi \ --inc-words android \ --recursive ``` ### Help/Usage: Just type `index_html` without any options to see the list of help ``` Usage: index_html generate [OPTIONS] Options: -b, [--base-dir=BASE_DIR] # Base directory # Default: . (current directory) -f, [--non-exts=one two three] # List of files without extension to search for -n, [--inc-words=one two three] # List of words to be included in the result if any -x, [--exc-words=one two three] # List of words to be excluded from the result if any -i, [--ignore-case], [--no-ignore-case] # Match case insensitively # Default: true -r, [--recursive], [--no-recursive] # Search for files recursively # Default: true -v, [--version], [--no-version] # Display version information -p, [--prefix=PREFIX] # Prefix string to the URL # Default: . -d, [--indent=N] # Indentation to each list item in the output # Default: 6 -o, [--output=OUTPUT] # Output file name # Default: index.html Generate the index.html base on simple criteria ``` This will generate the file `index.html` that you can open from your favourite browser. ### Sample output - Sample list of files from a given directory ```shell $index_html generate --base-dir=spec/fixtures --exts=rb java --recursive ``` The output file `index.html` should be generated with something like ```html File Listing

File List