Project

index_html

0.0
No commit activity in last 3 years
No release in over 3 years
index_htmlagilecreativity/index_htmlHomepageDocumentationSource CodeBug TrackerWiki
Generate the index.html from list of files
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
62,899
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.2.5
Total releases
20
First release
2014-04-14
Latest release
2015-07-16
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-06-19
Reverse Dependencies
1

 Dependencies

Development

awesome_print
~> 1.2
bundler
~> 1.7
coveralls
~> 0.7
fuubar
~> 2.0
guard-rspec
~> 4.3
pry
~> 0.10
pry-byebug
~> 2.0
rake
~> 10.3
rspec
~> 3.1
rubocop
~> 0.26

Runtime

agile_utils
~> 0.3
code_lister
~> 0.2
thor
~> 0.19
 Project Readme

index_html

Gem Version Dependency Status Code Climate Build Status Coverage Status Codeship Status for agilecreativity/index_html

Quickly generate the index.html files based on your simple criteria.

Note: start from version 0.1.2 this gem will follow the Semantic Versioning release schedule.

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:

gem install index_html
cd ~/Dropbox/ebooks/
index_html --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

Options:
  -b, [--base-dir=BASE_DIR]                # Base directory
                                           # Default: . (current directory)
  -e, [--exts=one two three]               # List of extensions to search for
  -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
$index_html --base-dir=spec/fixtures --exts=rb java --recursive

The output file index.html should be generated with something like

<html>
<title>File Listing</title>
<header>File List</header>
  <body>
    <ol>
      <li><a href="./demo1.xxx.java" target="_blank">./demo1.xxx.java</li>
      <li><a href="./demo1.xxx.rb" target="_blank">./demo1.xxx.rb</li>
      <li><a href="./demo2.xxx.java" target="_blank">./demo2.xxx.java</li>
      <li><a href="./demo2.xxx.rb" target="_blank">./demo2.xxx.rb</li>
      <li><a href="./sub-dir/demo3.yyy.java" target="_blank">./sub-dir/demo3.yyy.java</li>
      <li><a href="./sub-dir/demo3.yyy.rb" target="_blank">./sub-dir/demo3.yyy.rb</li>
      <li><a href="./sub-dir/demo4.yyy.java" target="_blank">./sub-dir/demo4.yyy.java</li>
      <li><a href="./sub-dir/demo4.yyy.rb" target="_blank">./sub-dir/demo4.yyy.rb</li>
    </ol>
  </body>
</html>
  • Run with simple prefix option
index_html --base-dir spec/fixtures --exts rb java --recursive --prefix http://localhost

The output file index.html should be something like

<html>
<title>File Listing</title>
<header>File List</header>
  <body>
    <ol>
      <li><a href="http://localhost/demo1.xxx.java" target="_blank">http://localhost/demo1.xxx.java</li>
      <li><a href="http://localhost/demo1.xxx.rb" target="_blank">http://localhost/demo1.xxx.rb</li>
      <li><a href="http://localhost/demo2.xxx.java" target="_blank">http://localhost/demo2.xxx.java</li>
      <li><a href="http://localhost/demo2.xxx.rb" target="_blank">http://localhost/demo2.xxx.rb</li>
      <li><a href="http://localhost/sub-dir/demo3.yyy.java" target="_blank">http:/localhost/sub-dir/demo3.yyy.java</li>
      <li><a href="http://localhost/sub-dir/demo3.yyy.rb" target="_blank">http://localhost/sub-dir/demo3.yyy.rb</li>
      <li><a href="http://localhost/sub-dir/demo4.yyy.java" target="_blank">http://localhost/sub-dir/demo4.yyy.java</li>
      <li><a href="http://localhost/sub-dir/demo4.yyy.rb" target="_blank">http://localhost/sub-dir/demo4.yyy.rb</li>
    </ol>
  </body>
</html>

Contributing

Bug reports and suggestions for improvements are always welcome, GitHub pull requests are even better!.

  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