Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metacorp/obsidian-augmented-canvas
Supercharge your Obsidian canvas experience with AI features.
https://github.com/metacorp/obsidian-augmented-canvas
obsidian obsidian-md obsidian-plugin
Last synced: about 2 months ago
JSON representation
Supercharge your Obsidian canvas experience with AI features.
- Host: GitHub
- URL: https://github.com/metacorp/obsidian-augmented-canvas
- Owner: MetaCorp
- License: mit
- Created: 2024-01-21T18:57:12.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-10T13:35:30.000Z (11 months ago)
- Last Synced: 2024-02-10T14:31:32.229Z (11 months ago)
- Topics: obsidian, obsidian-md, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 16.2 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Obsidian Augmented Canvas
A plugin for [Obsidian](https://obsidian.md) that "augments" Obsidian Canvas with AI features.
You need a OpenAI API Key to use this plugin, you can input it in the settings. The plugin only works with OpenAI latest model : `gpt-4-1106-preview`
## Key Features
This plugin adds three actions to the Menu of a note in the Canvas View.
1. Ask GPT on a specific note, the note content will be used as prompt. The note can be a text note, a md file or a PDF file. A new note will be created underneath the prompt note containing the AI response.
2. Ask question about a note. Also makes GPT generate a new note, the question is placed on the link between the two notes.
3. Generate questions on a specific note using GPT. The generated questions help you easily dig further into the subject of the note.
The links between notes are used to create the chat history sent to GPT.
## Additional Features
- The plugin adds an action to create an image in the context menu of a note in the canvas.
- The plugin adds a command named "Run a system prompt on a folder". Reading all md and canvas files present in that folder and sub-folders and inserting the response in the current canvas.
- The plugin adds a command named "Insert system prompt". This command will insert a chosen system prompt to the current canvas. The system prompts are fetch from [f/awesome-chatgpt-prompts (github.com)](https://github.com/f/awesome-chatgpt-prompts). You can also add your own system prompts in the settings.
- The plugin can create flashcards for you which can be revised using the [Spaced Repetition plugin](https://github.com/st3v3nmw/obsidian-spaced-repetition). Right click on a note to create flashcards. Then wait for GPT response and a new file will be created inside the folder specified in the settings. You can then revise this specific deck. Think about activating "Convert folders to decks and subdecks?" option in the settings of the Spaced Repetition plugin.
- The plugin adds a command named "Insert relevant questions". This command insert AI generated questions to the current canvas. The plugin reads and then sends your historical activity to GPT, reading the last X files modified (configurable in the settings).
- The plugin adds an action to the edge context menu to regenerate an AI response.
## Privacy
The content that is send to GPT can be viewed by toggling on the "Debug output" setting. The messages then appear in the console.
## Installation
- Not ready for market yet
- Can be installed via the [Brat](https://github.com/TfTHacker/obsidian42-brat) plugin
You can see how to do so in this Ric Raftis article: https://ricraftis.au/obsidian/installing-the-brat-plugin-in-obsidian-a-step-by-step-guide/
- Manual installation
1. Find the release page on this github page and click
2. Download the latest release zip file
3. Unzip it, copy the unzipped folder to the obsidian plugin folder, make sure there are main.js and manifest.json files
in the folder
4. Restart obsidian (do not restart also, you have to refresh plugin list), in the settings interface to enable the
plugin
5. Done!
## Credits
- [rpggio/obsidian-chat-stream: Obsidian canvas plugin for using AI completion with threads of canvas nodes (github.com)](https://github.com/rpggio/obsidian-chat-stream)
- [Quorafind/Obsidian-Collapse-Node: A node collapsing plugin for Canvas in Obsidian. (github.com)](https://github.com/quorafind/obsidian-collapse-node)
## Support
If you are enjoying this plugin then please support my work and enthusiasm by buying me a coffee
on [https://www.buymeacoffee.com/metacorp](https://www.buymeacoffee.com/metacorp).
.
