https://github.com/synox/mark-as-done-extension
Mark any page as Done
https://github.com/synox/mark-as-done-extension
Last synced: 10 months ago
JSON representation
Mark any page as Done
- Host: GitHub
- URL: https://github.com/synox/mark-as-done-extension
- Owner: synox
- License: mit
- Created: 2021-05-16T14:04:24.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T06:40:10.000Z (over 1 year ago)
- Last Synced: 2025-03-27T11:51:20.861Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.62 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[Chrome Extension](https://chrome.google.com/webstore/detail/mark-as-done/eamfmbodggklinbmhfgeogcpebhfoojb?hl=de) / [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/mark-as-done/)
# Mark as Done (Chrome & Firefox Extension)
> Easily track the reading status of any page.
> All the links to these pages are automatically highlighted on the original website,
> helping you keep track of your reading progress of large documentations or books.
For example, the following shows a partially read website, with some links marked as done.
And below is the extension popup, showing the status of pages and where you can update the status.
## Features
- Visual indicators for marked pages, the original website
- Export and import your marked pages list
# Icons
| Icon | Meaning |
|-------------------------------------------|-----------------------------|
| 
| Current page is not marked. |
| 
| Page is unread |
| 
| Page is marked as finished |
# How to Install
Chrome: [Mark as Done on Chrome Web Store](https://chrome.google.com/webstore/detail/mark-as-done/eamfmbodggklinbmhfgeogcpebhfoojb?hl=de)
Firefox: [Mark as Done on Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mark-as-done/)
Or: Clone the repository and "load unpacked" as described in [Chrome Developer Guide](https://developer.chrome.com/docs/extensions/mv3/getstarted/#manifest)
# Notes
* Only sites that have any marked pages are processed, ensuring no slowdown for sites not used with this extension.
* The permission is requested individually for each website, so that only the sites you use with this extension are affected.
* The logo 🔰 means: We are constantly learning. See [Source](https://emojipedia.org/japanese-symbol-for-beginner/)
# Reviews
If you find our extension useful, please consider leaving a review on the
[Chrome Web Store](https://chrome.google.com/webstore/detail/mark-as-done/eamfmbodggklinbmhfgeogcpebhfoojb?hl=de) or
[Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mark-as-done/). Your feedback is greatly appreciated!
# Development
Please use Commit Message Format:
- https://semantic-release.gitbook.io/semantic-release/#commit-message-format
- https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format
## Build
```bash
npm run build
```
## Run / Debug
```bash
npm run start:firefox
```
or
```bash
npm run start:chrome
```
## Lint
```bash
npm run lint
```
## Release
Releases are triggered automatically when merging pull requests. This also updates the extension in the chrome and firefox store.