Skip to content
Merged
Show file tree
Hide file tree
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
16 changes: 6 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
REGISTRY=ghcr.io
PROJECT_NAME=deframer.github.io
REGISTRY_IMAGE?=$(REGISTRY)/deframer/$(PROJECT_NAME)

IMAGE?=python:3.12

all:
@echo all

python-env:
sync:
uv sync

build:
mkdocs build
. .venv/bin/activate && \
mkdocs build

serve:
mkdocs serve -a 0.0.0.0:8000
. .venv/bin/activate && \
mkdocs serve -a 0.0.0.0:8000

clean:
rm -rf site
rm -rf site .env

lint:
docker run --rm -v "$$(pwd):/workdir" davidanson/markdownlint-cli2:latest
Expand Down
34 changes: 30 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
# News Defamer
# News Deframer

News Deframer Site
News Deframer will detect journalistic neutrality and framing in news articles. By leveraging Large Language Models (LLMs), it analyzes the headlines and bodies.

[Source Code](https://github.com/deframer/news-deframer/)
It is implemented as dual use. It can act as an **RSS Feed Proxy** or as a **browser plugin** to provide a "framing score" and context, helping users decide if an article is worth reading or if it is heavily biased.

[Bug Report](https://github.com/deframer/news-deframer/issues)
## What this project is and is not

- This is **not** a fake news detector!
- This project uses an LLM acting as a neutral journalist to analyze content for bias and adherence to neutral language.
- We use open transparent [prompts](https://github.com/deframer/news-deframer/blob/main/pkg/think/prompts) that can be run on any LLM.

Why is language analysis effective?

- We aim to help you avoid engaging with questionable headlines.
- Misinformation and speculation often rely on dark patterns, clickbait, and emotional triggers.
- Authors of misinformation often use disguise and vague language to avoid legal repercussions.

**WARNING**: We can have false positives / negatives.

## Installation

Set up your own [instance](https://github.com/deframer/news-deframer/blob/main/docs/SETUP.md).

## Overview

- [TODO / Status](https://github.com/deframer/news-deframer/blob/main/TODO.md)

## Resources

- [Source Code](https://github.com/deframer/news-deframer/)
- [Bug Report](https://github.com/deframer/news-deframer/issues)
- [License](https://github.com/deframer/news-deframer/blob/main/LICENSE)
Loading