/maoxian-web-clipper

A web extension to clip information from web page. Save it to your local machine to avoid information invalidation. Not bored registration, Not charged.

Primary LanguageJavaScriptMIT LicenseMIT

MaoXian Web Clipper

Home Page

Intro

MaoXian Web Clipper is a browser extension to clip information from web page and save it to your local machine to avoid information invalidation.

That's it, Not bored registration, Not charged.

Features

  • Local Storage - All file will save in local hard disk, you can control your data totally (e.g. Use dropbox to sync files)
  • Free Selection - You can select which area you want to clip.
  • Adjust selection - After you select a area, you can adjust your selection use hotkeys.
  • Category And Tag - Before your clipping, you can change title, input category and some tags.
  • Clipping History - Extension will record clipping history, and support search history (through title/category/tag).
  • Reset History - When you install this extension in new computer, you can reset your clipping history

Software Preview

Install

Get involved

You should create your own branch from develop and send a pull request back to it.

  1. install dependencies
npm install
  1. run the project

Developing

npm run watch

This command do three things. First, Compile the project. Second, watch the project's code modification and automatically compile it. Third, auto reload MaoXian that had been installed on browser.

All compiled code will placed in dist/extension/maoxian-web-clipper. After running this command, you need to install MaoXian into your browser.

If you use Chrome(or Chromium) to developing.

  • Go to extensions page(by visit url: chrome://extensions/)
  • Enable developer mode
  • Load unpacked(select dist/extension/maoxian-web-clipper)

If you use Firefox to developing.

  • Go to debugging page(by visit url: about:debugging)
  • Check Enable add-on debugging
  • Load Temporary Add-on(select dist/extension/maoxian-web-clipper)

Testing

npm test

Build MaoXian

Firefox:

You need to create a environment variable called MX_FIREFOX_ID which value is MaoXian's extention id(generated by AMO).

And run:

npm run build-firefox

Third party library

Thanks to these awesome libraries for making MaoXian's development become easier.

Contribution

You could help MaoXian Web Clipper development in many ways.

  • Sending feedback and suggestion.
  • Spread and promote this extension to your friend. Popularity is a strong power to drive developers.
  • If you're software developer, pull requests are welcome.