https://github.com/jrie/webviper
wipe the web using the viper
https://github.com/jrie/webviper
addon browser clean extension hide keywords purify userscript web
Last synced: 3 months ago
JSON representation
wipe the web using the viper
- Host: GitHub
- URL: https://github.com/jrie/webviper
- Owner: jrie
- License: gpl-3.0
- Created: 2025-01-25T19:45:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T20:42:10.000Z (5 months ago)
- Last Synced: 2025-01-25T21:24:08.443Z (5 months ago)
- Topics: addon, browser, clean, extension, hide, keywords, purify, userscript, web
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webViper
vipe the web using the webViper!
## webViper in short
*webViper* is a highly configureable element removal/cleaner for the web.
## Usage options for the viper
There are currently two flavours:
- *webViper-userScript.js* for usage with a browser "userscript"-addons like *Tampermonkey*, *Violentmonkey* (currently recommended!)
- *webViper.js* only the javascript code - as foundation for later.. u and me and we will see!
## Screenshot of a wiped item
## Filter rules, how to get clearing out working
*webViper* sources have comments, but to make things easy, here they are.
The definition for a website is in `const ruleSet = { ... }`, here a example:
```javascript
//
// Small config rules inside "ruleSet"
//
// const ruleSet = {
//
// A url which identifies the website
'websiteURL.net': {
keywords: [
// 'keyword1',
// 'keyword2',
],
excludes: [
// Can be empty
// 'exlucde1',
// 'exlucde2'
],
elementContainers: {
// CSSselector1: ['cssSelectorParent1', 'cssSelectorParent2'],
// CSSselector2: ['cssSelectorParent1', 'cssSelectorParent2']
//
// For example:
// a: ['article.stage-teaser', '.news-ticker-item'],
// 'a.stage-teaser__anchor': ['article.stage-teaser', '.news-ticker-item'],
// 'img.classNameClass': ['article.stage-teaser']
//
// You could also use:
// 'img#id': ['.className1', '#id']
// 'img.className': ['.className1', '#id']
//
},
removeElement: true
}
//
// }
//
```
### Rule template
For easier editing, the file `webViper-rule-template.js` contains a basic template for easy copy and paste into the userscript and script file.
## Video guide on how to add new rules
A video demonstration how to add and extend the `ruleSet` rules and identify a cleaning item.
https://github.com/user-attachments/assets/6d8ade11-f793-46f5-a692-fbe1cdf35888
## Help, support and issues or bugs
Please create a issue, with the ***website url*** and the ***keyword(s)*** which you want to be viped out.
**Note:** If the website changes/updates in between, you might - in advance - add two screenshots. One screenshot of page in your browser showing the content in question and one with the HTML markup with the offending content in HTML inside the *webdeveloper console*. Usually the *webdeveloper console* can be opened using, usually, the `F12`-key from within your browser (Firefox, Chrome...).
The issue can be reported at *issues*: https://github.com/jrie/webViper/issues
## Credits and kudos - shoutout!
Everyone at the *Laucharme* - we are a private group in **Telegram**, but if you know German or English, we can surely arrange a invite if you are keen to get in touch: We are *cool*, of course!
### And this fantastic cover art?
The source of the nice viper image is of *[https://reptilesmagazine.com](https://reptilesmagazine.com)* - I just made some post artwork.