No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec
.codeinventory.yml
.gitignore
.rspec
.rubocop.yml
.rubocop_todo.yml
.ruby-gemset
.ruby-version
.simplecov
.travis.yml
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
sitelink_generator.gemspec

README.md

Sitelink Generator

Search.gov powers the search box on 1,500 government websites.

This sitelink generator "decorates" organic web results to provide additional, value-added links to help searchers find what they're looking for.

See the sample results page below that shows sitelink-generated links for EDGAR filings for a search on apple on SEC.gov.

Sitelink-generated links for EDGAR filings on SEC.gov

Installation

Add sitelink_generator to your Gemfile and bundle install:

gem 'sitelink_generator'

Available Generators

Available generators include:

Usage

require 'sitelink_generator'

url = 'http://www.sec.gov/Archives/edgar/data/1577552/000119312514184994/d709111df1.htm'
SitelinkGenerator::SecEdgar.generate url
#=> [{:title=>"Full Filing",
#     :url=>"http://www.sec.gov/Archives/edgar/data/1577552/0001193125-14-184994-index.htm"},
#    {:title=>"Most Recent Filings for this Company",
#     :url=>"http://www.sec.gov/cgi-bin/browse-edgar?CIK=1577552&Find=Search&action=getcompany&owner=exclude"}]

Supported Ruby Versions

  • Ruby 2.1

Feedback

If you think you found a bug in SitelinkGenerator, you can submit an issue.