Source Code

The Adblock Plus project consists of multiple repositories. The modules page has a good overview of the most important ones.

Getting the source code from the Mercurial repositories

The Adblock Plus source code is hosted on our Mercurial server. You can see a list of all repositories through the web interface.

Here's how you clone the Adblock Plus for Firefox repository:

hg clone https://hg.adblockplus.org/adblockplus/

Here's how you get the source code for a specific version (e.g. Adblock Plus 2.3.1):

hg update -r 2.3.1

Mercurial documentation

Getting the source code from the GitHub mirrors

If you prefer to use Git, you can - we have GitHub mirrors for all our public repositories.

Here's how you clone the Adblock Plus for Firefox repository from GitHub:

git clone https://github.com/adblockplus/adblockplus

Here's how you get the source code for a specific version (e.g. Adblock Plus 2.3.1):

git checkout 2.3.1

Please note: We are currently using Mercurial subrepositories heavily, but are unable to mirror these as Git submodules. That means that you need to check the .hgsub file of each repository and clone all dependencies manually. This won't be necessary anymore once we've moved away from subrepositories.

Build instructions

Most of our repositories have README.md files with build instructions, please refer to those.

Source code documentation

We have automatically generated source code documentation for some projects: