Boilerplate project to port your bookmarklet to a Chrome extension
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Bookmarklet to Chrome Extension Boilerplate

Boilerplate to port your bookmarklet to a Chrome extension.

Simply copy your bookmarklet code into bookmarklet-code.js and test it localy, update the metadata and you're ready to pack it.

In order to publish your extension follow the steps here.

Test the chrome extension localy

The documentation below is from the Chrome Developer site, augmented with screenshots from this boilerplate project:

Extensions that you download from the Chrome Web Store are packaged up as .crx files, which is great for distribution, but not so great for development. Recognizing this, Chrome gives you a quick way of loading up your working directory for testing. Let's do that now.

Visit chrome://extensions in your browser (or open up the Chrome menu by clicking the icon to the far right of the Omnibox: The menu's icon is three horizontal bars. and select Extensions under the Tools menu to get to the same place).

Ensure that the Developer mode checkbox in the top right-hand corner is checked.

alt text

Click Load unpacked extension… to pop up a file-selection dialog.

alt text

Navigate to the directory in which your extension files live, and select it.

Alternatively, you can drag and drop the directory where your extension files live onto chrome://extensions in your browser to load it.

If the extension is valid, it'll be loaded up and active right away! If it's invalid, an error message will be displayed at the top of the page. Correct the error, and try again.

alt text

alt text

Updating the manifest.json metadata

You'll need to update the following keys in the manifest.json file:

  • name Name of the chrome extension
  • description Expain your chrome extension
  • homepage_url (optinal) Your projects website, e.g. github repo
  • author Your or your organizations name
  • icons Icon in various sizes for the Chrome Webstore
  • default_icon Icon for the browser extension bar


Check out bookmarklet-to-firefox-addon-boilerplate if you want to port your bookmarklet to Firefox as well.