Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.03 KB

README.md

File metadata and controls

65 lines (37 loc) · 2.03 KB
Raw

IMAGE ALT TEXT HERE

Obsidian AI Assistant

A plugin for Obsidian that uses OpenAI's API to assist users in their note-taking and writing process.

Features

  • File rename: Suggest a new name for the file based on its content.
  • Text completion: Suggest text based on what the user has already written, making it easier to write and faster to complete thoughts.
  • Text correction: The plugin can identify and suggest corrections for spelling, grammar, and style errors in real-time, making it easier to produce error-free writing.
  • Question answering: Answer questions based on the text in the note, providing quick access to information without leaving Obsidian.

Usage

File rename

  1. Right-click on a file in the file explorer and select "AI Rename".
  2. The plugin will suggest a new name for the file based on its content.

View demo

Text completion

  1. Type your text in the editor.
  2. Use palette command AI Complete to get suggestions.

If your cursor is at the end of the paragraph, the plugin will suggest text to complete the paragraph. If your cursor is in the new line, the plugin will suggest text based on the whole document.

View demo

Text summarization

  1. Select the text you want to summarize.
  2. Press right-click and select "AI Summarize".

View demo

Text explanation

  1. Select the text you want to explain.
  2. Press right-click and select "AI Explain".

View demo

Question answering

TBD

Requirements

  • Obsidian v0.9.8 or later
  • An OpenAI API key

Support

For support, please open an issue on the GitHub repository or contact us via email.

Contributing

Contributions are welcome! Please see the contribution guidelines for more information.

License

The plugin is released under the MIT License.