Repository files navigation

This code has moved to@adobe/helix-sidekick-extension

Browser-based helper for authoring Franklin projects

Navigate tohttps://www.hlx.live/tools/sidekick/ and follow the instructions.

Seehttps://github.com/adobe/helix-sidekick#readme

Franklin Sidekick supports a number of (optional) configuration options developers can add to the project to maximize the Sidekick experience.

See theAPI documentation.

Refer to theSidekick documentation to learn more about its features.

$ npm install

$ npmtest

$ npm run lint

Every development branch in this repository will be mirrored inhttps://github.com/adobe/helix-website with asidekick- prefix to enable enable branch testing:

1. Push changes to a branchissue-77
2. Note thesidekick-issue-77 branch inhttps://github.com/adobe/helix-website/branches
3. Go tohttps://sidekick-issue-77--helix-website--adobe.hlx.page/tools/sidekick/ to install a development version of the bookmarklet for your project

Note: Mirrored development branches inhttps://github.com/adobe/helix-website/branches must be deleted manually when no longer needed.

You can leverage Franklin CLI for local testing. If you haven't already installed it, run:npm i -g @adobe/helix-cli

1. Runnpm start on your local checkout of this repository
2. Go to `http://localhost:3001/ and follow the instructions.

If you want to test aconfig file before deploying it to your project:

1. Runhlx up on your local checkout of the project repository
2. Install a Sidekick bookmarklet for your project:https://www.hlx.live/tools/sidekick/
3. Edit the bookmarklet URL by appending,"devMode":"true" after"ref":"*" (* being your project branch)
4. Click the bookmarklet to launch Sidekick using your local config

The Sidekick module and bookmarklet gets staged automatically each time a pull request is merged intomain.

1. Go tohelix-website pull requests
2. Click theSidekick Release Candidate PR
3. Add a comment listing thehelix-sidekick PR(s) included in this release
4. Get a team member to review the Sidekick RC. The PR is based on asidekick-rc-* branch (* being a random ID) so the RC can be tested at:https://sidekick-rc-*--helix-website--adobe.hlx.page/tools/sidekick/
5. Once approved, merge the RC PR to deploy the changes into production