{"id":23284192,"url":"https://github.com/agilecreativity/index_html","last_synced_at":"2025-07-11T05:02:35.649Z","repository":{"id":16010273,"uuid":"18753728","full_name":"agilecreativity/index_html","owner":"agilecreativity","description":"Simple gem to create index.html from list of files based on simple search criteria (extension, contain words, exclude words, etc)","archived":false,"fork":false,"pushed_at":"2015-07-16T21:37:10.000Z","size":349,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-09T10:36:38.940Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/agilecreativity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-04-14T08:35:52.000Z","updated_at":"2014-11-18T22:15:53.000Z","dependencies_parsed_at":"2022-09-24T11:01:17.421Z","dependency_job_id":null,"html_url":"https://github.com/agilecreativity/index_html","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/agilecreativity/index_html","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Findex_html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Findex_html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Findex_html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Findex_html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agilecreativity","download_url":"https://codeload.github.com/agilecreativity/index_html/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agilecreativity%2Findex_html/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264502620,"owners_count":23618658,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-20T01:38:37.550Z","updated_at":"2025-07-11T05:02:35.627Z","avatar_url":"https://github.com/agilecreativity.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## index_html\n\n[![Gem Version](https://badge.fury.io/rb/index_html.svg)][gem]\n[![Dependency Status](https://gemnasium.com/agilecreativity/index_html.png)][gemnasium]\n[![Code Climate](https://codeclimate.com/github/agilecreativity/index_html.png)][codeclimate]\n[![Build Status](https://secure.travis-ci.org/agilecreativity/index_html.png)][travis-ci]\n[![Coverage Status](https://coveralls.io/repos/agilecreativity/index_html/badge.png)][coveralls]\n[![Codeship Status for agilecreativity/index_html](https://codeship.com/projects/baebac20-519d-0132-8657-6a8e4349286c/status)](https://codeship.com/projects/48400)\n\n[gem]: http://badge.fury.io/rb/index_html\n[gemnasium]: https://gemnasium.com/agilecreativity/index_html\n[codeclimate]: https://codeclimate.com/github/agilecreativity/index_html\n[travis-ci]: http://travis-ci.org/agilecreativity/index_html\n[coveralls]: https://coveralls.io/r/agilecreativity/index_html\n\nQuickly generate the index.html files based on your simple criteria.\n\nNote: start from version `0.1.2` this gem will follow the [Semantic Versioning][] release schedule.\n\n### Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'index_html'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install index_html\n\n### Usage\n\nSay you have lots of ebook files (pdf, epub, or mobi) and you have properly named them\nwith something like [ebook_renamer][].\n\nNow that you have the good data, if you like to create a quick index to all of the files\nthat have the specific word 'Android' in the title you could perhap try something like the following:\n\n```sh\ngem install index_html\ncd ~/Dropbox/ebooks/\nindex_html --base-dir . \\\n           --exts epub pdf mobi  \\\n           --inc-words android \\\n           --recursive\n```\n\n### Help/Usage:\n\nJust type `index_html` without any options to see the list of help\n\n```\nUsage:\n  index_html\n\nOptions:\n  -b, [--base-dir=BASE_DIR]                # Base directory\n                                           # Default: . (current directory)\n  -e, [--exts=one two three]               # List of extensions to search for\n  -f, [--non-exts=one two three]           # List of files without extension to search for\n  -n, [--inc-words=one two three]          # List of words to be included in the result if any\n  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any\n  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively\n                                           # Default: true\n  -r, [--recursive], [--no-recursive]      # Search for files recursively\n                                           # Default: true\n  -v, [--version], [--no-version]          # Display version information\n  -p, [--prefix=PREFIX]                    # Prefix string to the URL\n                                           # Default: .\n  -d, [--indent=N]                         # Indentation to each list item in the output\n                                           # Default: 6\n  -o, [--output=OUTPUT]                    # Output file name\n                                           # Default: index.html\n\nGenerate the index.html base on simple criteria\n```\n\nThis will generate the file `index.html` that you can open from your favourite browser.\n\n### Sample output\n\n- Sample list of files from a given directory\n\n```shell\n$index_html --base-dir=spec/fixtures --exts=rb java --recursive\n```\nThe output file `index.html` should be generated with something like\n\n```html\n\u003chtml\u003e\n\u003ctitle\u003eFile Listing\u003c/title\u003e\n\u003cheader\u003eFile List\u003c/header\u003e\n  \u003cbody\u003e\n    \u003col\u003e\n      \u003cli\u003e\u003ca href=\"./demo1.xxx.java\" target=\"_blank\"\u003e./demo1.xxx.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./demo1.xxx.rb\" target=\"_blank\"\u003e./demo1.xxx.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./demo2.xxx.java\" target=\"_blank\"\u003e./demo2.xxx.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./demo2.xxx.rb\" target=\"_blank\"\u003e./demo2.xxx.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./sub-dir/demo3.yyy.java\" target=\"_blank\"\u003e./sub-dir/demo3.yyy.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./sub-dir/demo3.yyy.rb\" target=\"_blank\"\u003e./sub-dir/demo3.yyy.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./sub-dir/demo4.yyy.java\" target=\"_blank\"\u003e./sub-dir/demo4.yyy.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"./sub-dir/demo4.yyy.rb\" target=\"_blank\"\u003e./sub-dir/demo4.yyy.rb\u003c/li\u003e\n    \u003c/ol\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n- Run with simple prefix option\n\n```shell\nindex_html --base-dir spec/fixtures --exts rb java --recursive --prefix http://localhost\n```\n\nThe output file `index.html` should be something like\n\n```html\n\u003chtml\u003e\n\u003ctitle\u003eFile Listing\u003c/title\u003e\n\u003cheader\u003eFile List\u003c/header\u003e\n  \u003cbody\u003e\n    \u003col\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/demo1.xxx.java\" target=\"_blank\"\u003ehttp://localhost/demo1.xxx.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/demo1.xxx.rb\" target=\"_blank\"\u003ehttp://localhost/demo1.xxx.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/demo2.xxx.java\" target=\"_blank\"\u003ehttp://localhost/demo2.xxx.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/demo2.xxx.rb\" target=\"_blank\"\u003ehttp://localhost/demo2.xxx.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/sub-dir/demo3.yyy.java\" target=\"_blank\"\u003ehttp:/localhost/sub-dir/demo3.yyy.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/sub-dir/demo3.yyy.rb\" target=\"_blank\"\u003ehttp://localhost/sub-dir/demo3.yyy.rb\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/sub-dir/demo4.yyy.java\" target=\"_blank\"\u003ehttp://localhost/sub-dir/demo4.yyy.java\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"http://localhost/sub-dir/demo4.yyy.rb\" target=\"_blank\"\u003ehttp://localhost/sub-dir/demo4.yyy.rb\u003c/li\u003e\n    \u003c/ol\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n### Contributing\n\nBug reports and suggestions for improvements are always welcome,\nGitHub pull requests are even better!.\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n[agile_utils]: https://rubygems.org/gems/agile_utils\n[code_lister]: https://rubygems.org/gems/code_lister\n[ebook_renamer]: https://rubygems.org/gems/ebook_renamer\n[rubocop]: https://github.com/bbatsov/rubocop\n[Semantic Versioning]: http://semver.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagilecreativity%2Findex_html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagilecreativity%2Findex_html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagilecreativity%2Findex_html/lists"}