obsidian-plugin/aidantilgner_AutogenObsidianPlugin
1
0
Fork 0
mirror of https://github.com/aidantilgner/AutogenObsidianPlugin.git synced 2026-07-22 09:20:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Aidan Tilgner 2024-02-01 14:44:49 -08:00 committed by GitHub
parent de2499ea85
commit 3a2bd2ba93
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -15,28 +15,17 @@ If you don't understand what these things mean, or you want to keep things simpl
# Usage
When you're working in a note, you can use the following syntax (@[prompt]) to trigger a generation:
```markdown
There are many classes that can be taken at Lorem Ipsum University, for example:
![autogen-demo-gif](https://github.com/AidanTilgner/AutogenObsidianPlugin/assets/45406132/e0547bdb-4f96-47e2-9f9d-45812346b77f)
@[a table with 3 columns: id, name, description and 3 rows with dummy entries for a list of classes one could take]
```
Then, whatever is in this selection, as well as a window of context from your note (capped at 8000 characters by default to limit token usage), will be sent to the language model of choice after a typing delay. The subsequent generation will replace your content, for example the above would be replaced by:
```markdown
There are many classes that can be taken at Lorem Ipsum University, for example:
| ID | Class Name | Class Description |
| ---- | ---- | ---- |
| 1 | Mathematics | This course covers foundational aspects of math |
| 2 | English Literature | Learn in-depth analysis of English literary works |
| 3 | Computer Science | Basic principles of computing and programming languages covered |
```
The main thing that is happening here is that the @[prompt] syntax is being used to trigger a replacement.
The main thing that is happening here is that the @[prompt] syntax is being used to trigger a replacement. The replacement **can be markdown** and will show up accordingly. Therefore you can use this for:
- Tables
- Dummy text
- Summary
- Elaboration
- Transformation of other text in the note
# Timeline
Additional features may be added if requested, but the idea is to keep the functionality relatively simple.
# Bugs, Questions, Etc.
If you have any questions or notice any unexpected behavior feel free to open an issue and I will try to reponse ASAP.
If you have any questions or notice any unexpected behavior feel free to open an issue and I will try to reponse ASAP.