README.md

Runme Web Extension

A browser web extension to add Runme buttons to markdown files on the internet. Download the extension on the marketplaces:

• Chrome
• Firefox

Development

Setup

Install dependencies via:

npm i

then build files via:

npm run bundle

building for Chrome:

npm run bundle:chrome

building for Firefox:

npm run bundle:firefox

Test

This project tests the extension files using component tests and the extension integration via e2e test with WebdriverIO.

Run unit/component tests:

npm run test:component

Run e2e tests:

npm run test:e2e

Building the Extension

Firefox

Bundle the extension by running npm run build. The generated files are in dist/. You can also grab a version from the latest test run on the main branch.

To load the extension in Firefox go to about:debugging#/runtime/this-firefox or Firefox > Preferences > Extensions & Themes > Debug Add-ons > Load Temporary Add-on...

Here locate the dist/ directory and open manifestv3.json

Chrome

Bundle the extension for Google Chrome by running npm run build:chrome. The generated files are in dist/. You can also grab a version from the latest test run on the main branch.

To load the extensions in Google Chrome go to chrome://extensions/ and click Load unpacked. Locate the dist directory and select manifest.json.

Files:

• content-script - UI files
• background.ts - Background script/Service worker
• index.html - popup UI

If you have any questions feel free to open an issue.