Mirrors/notesnook
1
0
Fork 0
mirror of https://github.com/streetwriters/notesnook.git synced 2025-12-16 11:47:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add README.md for web clipper (#7054)

Browse Source 
Signed-off-by: 01zulfi <85733202+01zulfi@users.noreply.github.com>
This commit is contained in:
01zulfi
2024-12-05 10:55:28 +05:00
committed by GitHub
parent 93af79926d
commit 75c346a460
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
extensions/web-clipper/README.md Normal file
View File

@@ -0,0 +1,30 @@
# Contributing guidelines
Please read the [contributing guidelines](../../CONTRIBUTING.md) beforehand.
### Setting web clipper locally
#### Running the web clipper
1. Install packages and setup the repo. Run this command in the repository root:
```sh
npm install
```
1. Run the Notesnook webapp:
```sh
npm run start:web
```
1. Navigate to the web clipper folder:
```sh
cd extensions/web-clipper
```
1. Run the web clipper:
```sh
npm run dev:chrome
```
#### Viewing the web clipper
1. Open chrome and go to `chrome://extensions`.
1. Turn on "Developer Mode".
1. Click on "Load unpacked" and select the `extensions/web-clipper/build` folder.