rofe / helix-sidekick

Browser extension for Helix Sidekick

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Helix Sidekick Browser Extension

Status

codecov CircleCI GitHub license GitHub issues LGTM Code Quality Grade: JavaScript semantic-release

The Helix Sidekick Browser Extension is a more powerful alternative to the existing Helix Sidekick Bookmarklet. The Helix Sidekick is a toolbar for authors working on Helix projects, providing them with context-aware actions like Preview, Edit or Publish.

Bookmarklet vs. Browser Extension

The bookmarklet configures Helix Sidekick for a single Helix project, and it needs to be reopened in every new browser window.

Use the browser extension to:

  • keep the Helix Sidekick open (or closed) while navigating multiple browser windows
  • configure Helix Sidekick for multiple projects without cluttering your browser's bookmark bar

Installation

  • Google Chrome: TBD
  • Mozilla Firefox: TBD
  • ...

Development

Install in Developer mode

  1. Clone this repository to your local disk: git clone https://github.com/rofe/helix-sidekick.git
  2. Open Chrome and navigate to chrome://extensions
  3. Turn on Developer mode at the top right of the header bar
    Developer mode
  4. Click the Load unpacked button in the action bar
    Load unpacked
  5. Navigate to the src directory of your local copy and click Select to install and activate the extension
  6. Verify if your Extensions page displays a box like this:
    Extension box
    and the tool bar shows a grayed out Helix icon:
    Extension icon disabled

Build

$ npm install

Test

$ npm test

Lint

$ npm run lint

About

Browser extension for Helix Sidekick

License:Apache License 2.0


Languages

Language:JavaScript 58.3%Language:CSS 32.8%Language:HTML 8.9%