/obsidian-aiwriter-plugin

Primary LanguageJavaScriptMIT LicenseMIT

AI Writer Plugin for Obsidian

The AI Writer plugin enhances your writing experience in Obsidian by providing AI-powered autocompletions. Whether you're working on a document, brainstorming ideas, or drafting notes, this plugin offers a range of commands to assist you in generating content effortlessly. The AI Writer uses Azure OpenAI. You need to have a active API-Key and URL for Azure OpenAI.

Installation

  1. Download the latest release of the AI Writer plugin from the Releases page for manual installation.
  2. Open Obsidian and navigate to Settings > Community plugins. (Not yet released)
  3. Click the Browse button and select the downloaded AI Writer plugin.
  4. Enable the AI Writer plugin.

Commands

Continue Writing

The Continue Writing command generates AI-driven suggestions to help you seamlessly extend your text. It understands the context of your writing and provides relevant autocompletions.

Short Summary

The Summary command summarizes the selected text, offering a concise overview of the content. This can be particularly useful for quickly grasping the main points of a lengthy document.

Rewrite Text

The Rewrite Text command leverages AI to rephrase or rewrite the text in the node. This is beneficial for exploring different ways to express ideas and enhancing the overall clarity of your writing.

Custom Prompt Window

The Custom Prompt Window command opens a customizable prompt window where you can input specific prompts or questions. The AI will then generate content based on your prompts, offering a tailored writing experience.

Feedback and Issues

If you encounter any issues or have suggestions for improvement, please create an issue on the plugin's GitHub repository.

Contributing

We welcome contributions! If you have ideas for new features or improvements, feel free to fork the repository and submit a pull request.

License

This plugin is released under the MIT License. Feel free to use and modify it according to your needs.


Happy writing with AI Writer in Obsidian!