Revisionist: AI-Powered Text Revision Plugin for Obsidian

Make your writing shine with AI! Revisionist provides seamless AI-powered text revision directly within Obsidian. Highlight text, tweak instructions, and get instant, polished suggestions.

---

Features

• One-Click AI Revisions: Highlight text and let Revisionist refine it for you.
• Customizable Instructions: Guide the AI with specific directions for revisions.
• Mobile and Desktop Friendly:
  • Access via the ribbon icon, command palette, or context menu.
• Word Count Guidance: Helps you stay within optimal text limits for better AI performance.
• Error Notifications: Provides clear feedback if settings or inputs need adjustment.

---

Installation

1. Open Obsidian.
2. Go to Settings > Community Plugins.
3. Search for Revisionist in the plugin library.
4. Click Install and then Enable the plugin.

---

Usage

Revise Your Writing

1. Select Text:
   • Highlight the text you want to improve.
2. Trigger Revision:
   • Click the wand icon in the ribbon.
   • Or open the Command Palette (Ctrl+P or Cmd+P) and search for "Revise Selected Text."
   • Or right-click the selected text and choose Revise with AI.
3. Configure Revision:
   • In the revision modal:
     • Add specific instructions (e.g., "Make this more concise" or "Rewrite for clarity").
     • Optionally adjust settings like temperature.
4. Review Results:
   • The plugin will generate a revised version of your text.
   • You can choose to retry, accept, or modify the revision.

---

Configuration

1. Open Settings > Revisionist.
2. Select your preferred AI provider (e.g., OpenRouter or LMStudio).
3. Configure any additional parameters like temperature, model, or API key (if needed).

---

Tips for Best Results

• Keep it Short: Select smaller portions of text (under 800 words) for optimal performance.
• Clear Instructions: Provide specific guidance to the AI for more accurate revisions.
• Experiment with Settings: Adjust parameters like temperature to fine-tune the AI's creativity.