Skip to content

TL;DR (Too Long; Didn't Read) - Summarize web pages with just one click (Chrome Extension)

Notifications You must be signed in to change notification settings

sazonovanton/TLDR

Repository files navigation

TL;DR (Too Long; Didn't Read) - Chrome Extension

English | Russian

This extension allows you to quickly obtain a brief summary of any web page or selected text. It helps you quickly retrieve the main ideas and points from a long text by querying the OpenAI API (or an alternative service).

Summary Screenshot

Features

  • Toolbar Button: Clicking extracts the entire page text and sends it for summarization.
  • Context Menu: Allows summarizing selected text via right-click and choosing the "Summarize via TL;DR" command.
  • API Integration: Sending text for summarization using a customizable system prompt (default: "Summarize this text in 3 key points. Format each point as a proper Markdown."). API requests are configurable through settings.
  • Extension Settings: Settings page allows you to set:
    • Base URL for API
    • API Key
    • System prompt
    • Model (text field, default: "o3-mini")
    • Advanced Settings:
      • Temperature (default: 0.8, range: 0-2.0) - Controls randomness in the output
      • Top p (default: 1.0, range: 0-1.0) - Controls diversity via nucleus sampling
      • Top k (default: 0, integer ≥ 0) - Limits the cumulative probability of tokens
      • Frequency Penalty (default: 0, range: -2.0 to 2.0) - Reduces repetition based on frequency
      • Presence Penalty (default: 0, range: -2.0 to 2.0) - Encourages new topics
      • Repetition Penalty (default: 0, range: -2.0 to 2.0) - Penalizes token repetition
      • Max Tokens (optional, integer ≥ 1) - Maximum number of tokens to generate

File Structure

  • manifest.json – Chrome extension manifest specifying permissions and attached scripts.
  • background.js – Service worker handling extension button clicks and context menu, extracting text and sending API requests.
  • options.html and options.js – Settings page allowing users to set extension parameters.
  • content_script.js – Simple script loaded on all pages (can be used for additional functions).

How to Install (manual)

  1. Ensure you have Google Chrome installed.
  2. Download all extension files (manifest.json, background.js, options.html, options.js, content_script.js, README.md) into one folder.
  3. Open Google Chrome and go to the extensions page by entering chrome://extensions/ in the address bar.
  4. Enable "Developer mode" in the top right corner of the page.
  5. Click the "Load unpacked extension" button and select the folder with extension files.
  6. The extension will be installed and immediately available for use.

Usage

  • To summarize an entire page:
    • Click the extension icon in the toolbar. The entire page text will be extracted and sent for summarization.
  • To summarize selected text:
    • Select the necessary text and right-click. Choose the "Summarize via TL;DR" option.
  • The summarization result will be displayed in a popup modal directly on the page.

Configuration

Open the extension settings page:

  • Fill in the "Base URL" field (default https://api.openai.com/v1, but can be changed to another service with OpenAI-compatible API like Openrouter).
  • Enter your "API Key".
  • Edit the "System Prompt" if necessary.
  • Enter the model name in the "Model" text field (default: o3-mini).

Settings are saved when clicking the "Save settings" button.

Settings Screenshot

About

TL;DR (Too Long; Didn't Read) - Summarize web pages with just one click (Chrome Extension)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published