pinmenote-extension/README.md

60 lines
1.6 KiB
Markdown
Raw Normal View History

2023-11-01 23:40:58 +01:00
pinmenote-extension
2022-12-17 22:55:05 +01:00
---
### Description
2023-05-04 17:17:23 +02:00
Browser extension
2022-12-17 23:19:16 +01:00
2023-03-23 23:39:35 +01:00
- offline first with p2p in mind
2023-03-23 23:39:10 +01:00
2023-10-31 18:07:25 +01:00
### Install
```shell
npm install
```
2022-12-17 23:19:16 +01:00
### Run
2023-10-31 18:07:25 +01:00
```shell
npm run dev
2022-12-17 23:19:16 +01:00
```
2023-04-12 05:13:49 +02:00
2023-10-31 18:07:25 +01:00
### Release Production
```shell
./bin/build-chrome-prod
./bin/build-firefox-prod
```
### Website
2023-04-26 04:27:14 +02:00
[https://pinmenote.com](https://pinmenote.com)
2023-05-04 17:17:23 +02:00
### Features Summary
2023-04-26 04:27:14 +02:00
- select website area, add comment and draw on selected part
2023-05-04 17:17:23 +02:00
- save website / part of website as single page for offline use
2023-04-26 04:27:14 +02:00
- capture image / map / canvas
- download table as csv
2023-05-04 17:17:23 +02:00
- add / manage note to any website or without website
2023-04-26 04:27:14 +02:00
- html preview and board view
- add and manage tags of any content you saved
2023-05-04 17:17:23 +02:00
- automatic reverse index of saved content
- smart search using levenshtein distance, dates, website addresses
2023-04-12 05:13:49 +02:00
### Known issues
#### Canvas
When `preserveDrawingBuffer` is set to false, we save 1x1 empty image because problems with access to drawing buffer.
see [https://stackoverflow.com/a/27747016](https://stackoverflow.com/a/27747016)
```
can.getContext("webgl2", { preserveDrawingBuffer: true })
```
#### Shadow root
2023-05-31 18:21:33 +02:00
Open shadow root is not always displayed or parsed correctly - but at least it matches mht quality, and sometimes it's better.
2023-05-11 20:46:59 +02:00
Saving fragment / adding pin to shadow root is not working right now.
#### Youtube
2023-05-31 18:21:33 +02:00
youtube somehow breaks layout (fixed with skip problematic elements that don't affect visual)
### Limitations
2023-05-04 17:17:23 +02:00
- Sometimes what you see / saw is what you saved
- some websites offload content not displayed on page - ex. using shadow dom
- the same condition applies to websites that don't load images until you scroll to them
- Not downloading svg icons from css files - to limit number of requests