Readied Docs
Guide

Built-in Plugins

Overview of the 8 built-in plugins that ship with Readied

Built-in Plugins

Readied ships with 8 built-in plugins that cover core editing and productivity features. All plugins can be enabled or disabled from Settings > Plugins.

Word Count

Shows word, character, and line counts in the editor status bar. The counts update in real-time as you type.

  • Plugin ID: readied-word-count
  • Toggle: Use the command palette and search for "Toggle Word Count"
  • Configuration: None
  • Keyboard shortcuts: None

Reading Time

Displays estimated reading time in the editor status bar, calculated at approximately 200 words per minute. The minimum displayed value is 1 minute.

  • Plugin ID: readied-reading-time
  • Toggle: Use the command palette and search for "Toggle Reading Time"
  • Configuration: None
  • Keyboard shortcuts: None

Active Line Highlight

Highlights the line where the cursor is positioned, making it easier to track your place in the document. The highlight updates as you move the cursor and clears when switching notes.

  • Plugin ID: readied-active-line
  • Toggle: Use the command palette and search for "Toggle Active Line Highlight"
  • Configuration:
    • enabled (boolean, default: true) — Whether the highlight is active
  • Keyboard shortcuts: None

Focus Mode

Dims all lines except the current one for distraction-free writing. All non-active lines fade to 30% opacity with a smooth transition.

  • Plugin ID: readied-focus-mode
  • Toggle: Cmd+Shift+F (macOS) / Ctrl+Shift+F (Windows/Linux), or use the command palette
  • Configuration:
    • enabled (boolean, default: false) — Enable focus mode on startup
  • Keyboard shortcuts:
    • Cmd+Shift+F / Ctrl+Shift+F — Toggle focus mode

Typewriter Mode

Keeps the current line centered in the editor viewport as you type, simulating a typewriter. The editor smoothly scrolls to keep the cursor near the vertical center. Scrolling is only triggered when the cursor moves more than 40 pixels from center.

  • Plugin ID: readied-typewriter-mode
  • Toggle: Cmd+Shift+T (macOS) / Ctrl+Shift+T (Windows/Linux), or use the command palette
  • Configuration:
    • enabled (boolean, default: false) — Enable typewriter mode on startup (persisted via config)
  • Keyboard shortcuts:
    • Cmd+Shift+T / Ctrl+Shift+T — Toggle typewriter mode

Export Markdown

Copies the current note to your clipboard. Supports two formats: raw Markdown and rendered HTML.

  • Plugin ID: readied-export-markdown
  • Commands:
    • Copy as Markdown — Copies the raw Markdown source
    • Copy as HTML — Converts to HTML and copies (supports headers, bold, italic, code blocks, inline code, links, and lists)
  • Configuration: None
  • Keyboard shortcuts:
    • Cmd+Shift+C / Ctrl+Shift+C — Copy as Markdown

AI Assistant

An AI-powered writing assistant panel powered by Claude. Opens a side panel where you can ask questions about your notes, get grammar suggestions, request summaries, and more. The assistant uses RAG (Retrieval-Augmented Generation) over your local notes for context-aware responses.

  • Plugin ID: readied-ai-assistant
  • Toggle: Cmd+Shift+A (macOS) / Ctrl+Shift+A (Windows/Linux), or click the sparkles icon in the editor header
  • Commands:
    • Toggle AI Assistant — Open or close the panel
    • Ask AI About Current Note — Open the panel focused on the active note
  • Configuration:
    • apiKey (string, default: "") — Your Anthropic API key from console.anthropic.com
    • model (enum, default: claude-sonnet-4-5-20250929) — Claude model to use. Options: Claude Sonnet 4.5, Claude Haiku 4.5
    • maxContextNotes (range, default: 5, min: 1, max: 20) — Maximum number of notes to include as context
  • Keyboard shortcuts:
    • Cmd+Shift+A / Ctrl+Shift+A — Toggle AI Assistant

Tip: You need to provide your own Anthropic API key in Settings > Plugins > AI Assistant to use this feature.

Tables

Full GFM (GitHub Flavored Markdown) table support with visual editing, WYSIWYG rendering, sortable columns in preview, and CSV export.

  • Plugin ID: readied-tables
  • Features:
    • Insert Table — Opens a visual grid picker to create a table with your chosen dimensions (up to 10 rows by 6 columns)
    • WYSIWYG Rendering — Tables are rendered as formatted HTML in the editor. Click into a table to see and edit the raw Markdown
    • Sortable Preview — Tables in the preview pane have clickable column headers for sorting (ascending/descending, supports numeric and string sorting)
    • Export to CSV — Copies the table at the cursor position to the clipboard as CSV
  • Commands:
    • Insert Table — Open the table size picker
    • Toggle Table WYSIWYG — Enable or disable visual table rendering in the editor
    • Export Table to CSV — Copy the table at cursor as CSV
  • Configuration:
    • wysiwygEnabled (boolean, default: true) — Whether tables render visually in the editor
  • Keyboard shortcuts:
    • Cmd+Alt+T / Ctrl+Alt+T — Insert table