Skip to content

Remarklet adds visual editing capabilities to any web page.

License

Notifications You must be signed in to change notification settings

ZachWatkins/Remarklet

Folders and files

NameName
Last commit message
Last commit date
Mar 10, 2025
Mar 10, 2025
Feb 24, 2024
Mar 10, 2025
Mar 10, 2025
Mar 10, 2025
Mar 10, 2025
Mar 8, 2025
Feb 25, 2015
Feb 25, 2024
Mar 10, 2025
Feb 24, 2024
Feb 25, 2024
Mar 10, 2025
Mar 10, 2025
Mar 10, 2025
Mar 21, 2024
Mar 10, 2025
Mar 10, 2025
Mar 10, 2025
Mar 10, 2025

Repository files navigation

Remarklet - JavaScript web page editor controls

Remarklet adds visual editing capabilities to any web page. This makes modifying and commenting on them remarkably easy!

Features

  • Drag elements around the page
  • Resize elements
  • Edit text

Installation

This package can be installed with:

  • npm: npm install @zw/remarklet
  • yarn: yarn add @zw/remarklet
  • pnpm: pnpm add @zw/remarklet
  • unpkg: <script src="https://unpkg.com/@zw/remarklet"></script>
  • jsdelivr: <script src="https://cdn.jsdelivr.net/npm/@zw/remarklet"></script>

Example

To use Remarklet, you need to import the module in your JavaScript file:

import remarklet from "@zw/remarklet";

Then, you can activate or deactivate the features it provides:

import remarklet from "@zw/remarklet";
remarklet.activate();
// Now users can drag, resize, and edit elements on the page.
remarklet.deactivate();
// Now event handlers are unregistered and will be re-registered the next time remarklet.activate() is called.

Feature Roadmap

  • Insert Note
  • Delete Elements
  • View Grid
  • Copy Elements
  • Export the edited page as an HTML file
  • Insert Image
  • Insert Code
  • Save
  • Restore

Copyright 2025 Zachary Kendall Watkins [email protected] (https://github.com/zachwatkins)