Skip to content

atomx/prebid.github.io

 
 

Repository files navigation

Home of the Prebid.js documentation and downloads at Prebid.org.

Thanks in advance for any contributions! All contributors are listed in the Thanks section below.

Please see the sections below before submitting a PR.

This is the repo that controls Prebid.org. We welcome any contributions.

For smaller changes, such as fixing a typo or adding a new section to an existing page, submit a pull request.

For larger changes such as reorganizing the site and moving/removing content, you may want to open an issue so we can discuss the work beforehand. This is a good idea because:

  • We want to value your time, so you don't do unnecessary work
  • We want to value our users' time; we don't want to break links and bookmarks for users

All docs are under the license shown in the LICENSE file in this directory.

The site uses Jekyll, which is written in the Ruby language.

To follow the instructions in the next section, you will need to install the Bundler Ruby gem, probably like so:

$ gem install bundler

Before submitting a pull request, you should run the site locally to make sure your edits actually work.

To get started editing the site and seeing your changes, clone this repo and enter the following commands in your terminal:

  • cd /path/to/prebid.github.io

  • bundle install

  • bundle exec jekyll serve

You should see output that looks something like this:

Configuration file: /Users/rloveland/Dropbox/Code/prebid.github.io/_config.yml  
            Source: /Users/rloveland/Dropbox/Code/prebid.github.io  
       Destination: /Users/rloveland/Dropbox/Code/prebid.github.io/_site  
 Incremental build: disabled. Enable with --incremental  
      Generating...   
                    done in 13.596 seconds.  
 Auto-regeneration: enabled for '/Users/rloveland/Dropbox/Code/prebid.github.io'  
Configuration file: /Users/rloveland/Dropbox/Code/prebid.github.io/_config.yml  
    Server address: http://127.0.0.1:8080/  
  Server running... press ctrl-c to stop.  
...  
...  

Open the Server address URL in your browser, and you should see a locally running copy of the site.

Please don't alphabetize the lists of adapters in your PR, either on the home page or the downloads page.

The adapters are not listed in alphabetical order, they're listed in the order in which they were added to the Prebid.js repo, using (approximately) this command:

$ for file in `git ls-files`; do HASH=`git rev-list HEAD $file | tail -n 1`; \  
  DATE=`git show -s --format="%ci" $HASH --`; printf "%-35s %s\n" $file "$DATE"; done

Please don't submit PRs to the Prebid.org downloads page. That page gets updated as part of the Prebid.js release process and requires some updates to backend code that builds the library download for users.

This means an adaptor is not available to download from Prebid.org as soon as the code gets merged into Prebid.js - it will be available after the next release (usually in a couple of weeks).

Many thanks to the following people who have submitted content to Prebid.org. We really appreciate the help!

In alphabetical order:

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.7%
  • HTML 43.9%
  • CSS 3.9%
  • Other 0.5%