Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/buszk/obsidian-ai-editor

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/buszk/obsidian-ai-editor
Owner: buszk
License: mit
Created: 2023-08-13T18:36:25.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-01-11T00:11:51.000Z (6 months ago)
Last Synced: 2024-02-11T03:06:38.077Z (5 months ago)
Language: TypeScript
Size: 189 KB
Stars: 13
Watchers: 1
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

project-awesome - buszk/obsidian-ai-editor - (TypeScript)

README

# Obsidian AI Editor Plugin

The Obsidian AI Editor Plugin is a powerful tool that integrates artificial intelligence capabilities into the Obsidian App. With this plugin, you can enhance your writing, research, and brainstorming processes by leveraging AI-generated suggestions and content. Whether you're looking for creative prompts, relevant information, or grammar improvements, the AI Editor Plugin has you covered.

# Features
- AI-Powered Processing: Ask LLM to process your documents, easily integrated inside Obsidian.
- Unlock Your Creativity: The plugin is designed to be configurable and fit your need. It's easy to create your own command and integrate LLM as part of workflow.
- Text-summarization (Demo): We configured text summarization command to demonstrate the plugin.

# Usage
1. Get API Key from OpenAI from this [page](https://platform.openai.com/account/api-keys). You will have to link your credit card.
2. Go to Settings in Obsidian. Click AI Editor tab. Enter your API key.
3. Go to any note you want to summarize. Use the initial TLDR (Too Long; Didn't Read) command.
4. Go back to Settings to add more commands. You can configure basic command options like prompts, text selection and output action.
5. Note that you need to reload the app to get new command registered for now.

# Feedback and Contribution
If you have any suggestions, encounter issues, or wish to contribute to the development of the plugin, checkout the [GitHub repository](https://github.com/buszk/obsidian-ai-editor).