obsidian-plugin/profsynapse_obsidian-revisionist
1
0
Fork 0
mirror of https://github.com/profsynapse/obsidian-revisionist.git synced 2026-07-22 05:31:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
32 commits 1 branch 5 tags 19 MiB
TypeScript 98.7%
CSS 0.9%
JavaScript 0.4%
Find a file
ProfessorSynapse b495acd313 feat: Implement RetryManager with exponential backoff and circuit breaker patterns 
- Added RetryManager class for handling retry logic with configurable parameters.
- Introduced CircuitBreaker class to manage operation failures and state transitions.
- Created RetryPatterns utility for common retry scenarios (API calls, database operations, file operations).
- Developed ValidationUtils for comprehensive validation of configurations and inputs.
- Added schema validation capabilities for structured data validation.
- Implemented quick setup function for easy initialization of the lab kit.
- Enhanced environment validation to ensure proper configuration and readiness.
- Created performance monitoring utilities for tracking operation durations.
2025-08-10 16:43:58 -04:00
src feat: Implement RetryManager with exponential backoff and circuit breaker patterns 2025-08-10 16:43:58 -04:00
.gitignore update version to 0.3.0 and improve OpenAI error handling 2025-07-01 07:15:21 -04:00
esbuild.config.mjs first commit 2024-11-29 19:45:42 -05:00
LICENSE Create LICENSE 2024-12-04 05:32:01 -08:00
manifest.json update version to 0.3.0 and improve OpenAI error handling 2025-07-01 07:15:21 -04:00
package-lock.json feat: Implement RetryManager with exponential backoff and circuit breaker patterns 2025-08-10 16:43:58 -04:00
package.json feat: Implement RetryManager with exponential backoff and circuit breaker patterns 2025-08-10 16:43:58 -04:00
README.md Merge branch 'main' of https://github.com/ProfSynapse/obsidian-revisionist 2024-12-05 06:59:42 -05:00
styles.css fixed quick hit buttons 2024-12-19 12:51:00 -05:00
tsconfig.json removed node modules from git 2024-11-29 19:49:45 -05:00

README.md

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.