Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(rules): add date filter pattern #93

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions content/docs/rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,41 @@ Available Fields:
- `EntryContent`
- `EntryAuthor`
- `EntryTag`
- `EntryDate`

### Date Patterns

The `EntryDate` field supports the following date patterns:

- `future` - Match entries with future publication dates
- `before:YYYY-MM-DD` - Match entries published before a specific date
- `after:YYYY-MM-DD` - Match entries published after a specific date
- `between:YYYY-MM-DD,YYYY-MM-DD` - Match entries published between two dates

Date format must be YYYY-MM-DD, for example: 2024-01-01

### Block Rules

Block rules ignores articles that match a single rule.

For example, the rule `EntryTitle=(?i)miniflux` will ignore all articles with a title that contains the word Miniflux (case insensitive).

For example:

- `EntryDate=future` will ignore articles with future publication dates
- `EntryDate=before:2024-01-01` will ignore articles published before January 1st, 2024

### Keep Rules

Keep rules will keep articles that match a single rule.

For example, the rule `EntryTitle=(?i)miniflux` will keep only the articles with a title that contains the word Miniflux (case insensitive).

For example:

- `EntryDate=between:2024-01-01,2024-12-31` will keep only articles published in 2024
- `EntryDate=after:2024-03-01` will keep only articles published after March 1st, 2024

### Global Rules & Feed Rules Ordering

Rules are processed in this order:
Expand Down