Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderadam committed Jul 1, 2024
0 parents commit 8b9285f
Show file tree
Hide file tree
Showing 12 changed files with 3,914 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .aglintrc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AGLint config file
# Documentation: https://github.com/AdguardTeam/AGLint#configuration
root: true
extends:
- aglint:recommended
syntax:
- Common
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/adblock_rule_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Adblock Rule Request
about: Request a new adblock rule for specific content.
title: "[Rule Request] - "
labels: "rule request"
assignees: ''
body:
- type: markdown
attributes:
value: "### URL(s) where the issue occurs\n\nPlease provide the URL(s) where the ad or unwanted content appears. If the issue occurs on multiple pages, list them too."
- type: input
id: urls
attributes:
label: URL(s)
description: "Enter the URL(s) where the issue occurs."
placeholder: "https://example.com/page1"
validations:
required: true
- type: markdown
attributes:
value: "### Screenshot(s)\n\nAttach screenshots highlighting the ad or unwanted content you wish to block. This helps in understanding exactly what needs to be addressed."
- type: file
id: screenshots
attributes:
label: Screenshot(s)
description: "Upload screenshots highlighting the ad or unwanted content. You can upload more than one file."
render: "image"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: "Describe in detail what you would like to block or change on the page(s). Include any specific elements (e.g., ad banners, trackers, pop-ups) and their locations on the page if possible."
placeholder: "Describe what to block..."
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional Information
description: "Any other information you think might be helpful for creating the adblock rule. This could include details about the website, the type of ad, or any other relevant context."
placeholder: "Any other information..."
validations:
required: false
---
Empty file.
37 changes: 37 additions & 0 deletions .github/workflows/update_metadata.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Update Adblock List Metadata

on:
push:
branches:
- main

jobs:
update-metadata:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: '18'

- name: Install dependencies
run: yarn install

# https://github.com/AdguardTeam/AGLint?tab=readme-ov-file#introduction
- name: Run linting
run: yarn aglint alexanderadam.txt

- name: Update metadata
run: |
sed -i 's/! Last modified: .*/! Last modified: $(date +%Y-%m-%d)/' adblock.txt
- name: Commit and push if changed
run: |
git config --global user.email "action@github.com"
git config --global user.name "GitHub Action"
git add adblock.txt
git commit -m "Update metadata" || exit 0 # Exit gracefully if no changes
git push
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules

5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"adguard.adblock"
]
}
9 changes: 9 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"cSpell.words": [
"adblock",
"adblocker",
"adblockers"
],
"adblock.enableAglint": true,
"adblock.packageManager": "yarn"
}
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# 🛑 Alex's Adblock list

This repository hosts a curated list of adblock rules designed to enhance your browsing experience by blocking ads, trackers, and other unwanted web content.

Have a look at the [installation instructions](https://alexanderadam.github.io/adblock_list/#installation) to get started!

## Contributing

Contributions to improve the adblock list are welcome! If you have suggestions or want to add new rules, please follow these steps:

1. [Fork the repository](https://github.com/alexanderadam/adblock_list/fork).
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a new Pull Request.

## Acknowledgments

- Thanks to everyone who has contributed to this project!
- Special thanks to the uBlock Origin team for their fantastic ad-blocking tool.

Enjoy a cleaner, faster web browsing experience with this curated list!
Loading

0 comments on commit 8b9285f

Please sign in to comment.