Skip to content

Writing companion for AI content generation.

License

Notifications You must be signed in to change notification settings

ckt1031/obsidian-wordwise-plugin

Repository files navigation

Obsidian AI Wordwise

Welcome to Obsidian WordWise, a community project adding AI features into Obsidian to simplify your workflow. This plugin integrates prompts, tools and commands powered by AI to boost productivity and enhance user experience.

Supported Providers

  • OpenAI - Advanced and powerful.
  • Google Gemini - Free and performs well in most tasks.
  • Anthropic - Specializes in generating neutral text.
  • OpenRouter - Integrates AI models with OpenAI and other open-source models.
  • PerplexityAI - Offers online models and fine-tuned LLaMA models.
  • Cohere - Offers advanced AI models for text generation and comprehension.

Commands

The plugin provides the following commands:

  • Improve Writing: Improve your writing such as grammar, sentence structure, and word choice.
  • Fix Grammar: Fix grammar mistakes in your text.
  • Make Shorter: Condense your text while retaining the main points, ideal for creating summaries.
  • Make Longer: Expand on your text to provide more detail or explanation.
  • Highlight Main Point: Highlight the only main idea in your text.
  • Paraphrase: Rewrite your text in a different way while keeping the same meaning, perfect for avoiding repetition or enhancing understanding.
  • Simplify Text: Simplify your text to make it easier to read.
  • Custom Instructions: Provide custom instructions to the AI to generate specific content.

Installation

Community Plugins

  1. Open Obsidian and go to Settings > Community Plugins.
  2. Install the plugin here.

BRAT Installation (Beta)

  1. Install BRAT.
  2. Enter the plugin url https://github.com/ckt1031/obsidian-wordwise-plugin in the BRAT settings.
  3. Enable the plugin and enjoy!

Manual Installation

You can manually install the Obsidian Wordwise Plugin:

  1. Download 3 files - main.js, manifest.json, and styles.css - from the latest release.
  2. Create a folder named "wordwise" in your Obsidian vault's plugins folder.
  3. Activate the plugin by toggling on its switch under Settings > Community Plugins.

License

This project is licensed under the MIT License. See LICENSE for details.