Awesome
<div align="center"> <img src="imgs/background.png" width="50%" />Awesome GPT
👋
Welcome to share your command tag here using Meet API.
<img src="https://user-images.githubusercontent.com/51939531/228763331-90baa9aa-8bef-4b32-9d6f-35538b58b158.png" width="80%" /> </div>🚀 Main Features
Features about GPT:
- 🔗 Integrate with Zotero: You can use the plugin to search and ask items in the library based on the selected text or the PDF file.
- 🧠 Use GPT to generate reply text: support
gpt-3.5-turbo
andgpt-4
- 🏷️ Command tags: Click once to accelerate your research.
- 💬 Ask questions about current PDF file (full-text or selected text).
- 💬 Ask questions about selected paper (Abstract).
- 📝 Summarize the selected paper into several highly condensed sentences.
- 🔍 Search items in the library based on the selected text.
- ... ...
- ⚙️ Advanced settings for GPT: You can set the api key, model name, api url, temperature.
- 📚 Integrate with Better Notes: You can directly open this plugin when using Better Notes.
Features about UI:
- 🎨 Real-time markdown rendering for reply text: Latex and mathjax are supported.
- 🔍 Zoom in and out of the reply text or the size of the plugin window.
- 🖱️ Move the plugin window to any position on the screen.
- 📋 Copy the reply text to the clipboard.
- ⚠️ Detailed error message will be displayed when the request fails.
- 🔧 Compatible with Zotero 6 and Zotero 7.
- 🎉 Discover more exciting features that are not listed here.
How to use
- Get
.xpi
file- download latest release
.xpi
file - or build this project [1] to generate a
.xpi
file
- download latest release
- Install
.xpi
file in Zotero [2] - Open Zotero GPT [3]
- Set your
OpenAI
secret key [4]
[1] Build the project
Here is an example on how to build this project. For more information on how to build, please visit this project: https://github.com/windingwind/zotero-plugin-template
git clone https://github.com/MuiseDestiny/zotero-gpt.git
cd zotero-gpt
npm install
npm run build
The generated .xpi
file in the build directory is the extension that you can install in Zotero.
[2] Install the extension in Zotero
Open Zotero. In the top menu bar, click on Tools > Add-ons
.
Click on the gear icon at the top right of the window. Click on Install Add-on From File
and open the generated .xpi
file in the build directory from the previous step.
[3] Open/Exit Zotero GPT
Action | Shortcut |
---|---|
Open | <img src="https://github.com/MuiseDestiny/zotero-gpt/assets/51939531/f76b23ee-8c54-47da-823c-8c14faa88a87" width="20%"> |
Exit | ESC |
Multi-line editing | Shift + Enter |
[4] Set up the API key
Hi, Command Tag.
👻 Follow the steps below, and you will gain a new understanding of command tags.
Step | Description | Supplementary Information |
---|---|---|
1 | Open Zotero GPT | Refer to [3] Open/Exit Zotero GPT |
2 | Type #Tag Name and press Enter | |
3 | Input your prompt or code | |
4 | Run your tag | Press Ctrl + R |
5 | Save your tag | Press Ctrl + S |
6 | Long press a command tag to access the editing interface | |
7 | Modify the tag's color, position, or trigger; remember to save with Ctrl + S | |
8 | Press ESC to exit the editing interface | Remember to save your changes with Ctrl + S before exiting |
9 | Long press the right mouse button to delete a tag | Note: Build-in tags do not support deletion |
How to run a command tag
Trigger is an attribute of a command tag, as are color and position. Long press any label to view/modify its trigger word. It supports both plain text and JS regular expressions.
How to write a code block
You can find some build-in APIs here.
A simple example:
Summarize the following paragraph for me:
${Meet.Zotero.getPDFSelection()}
Here, the Summarize the following paragraph for me:
represents plain text, while ${your code}
denotes a code snippet. Undoubtedly, if you are familiar with Zotero APIs, you can develop your own code. The code snippet will be executed, and the text returned by the code snippet will replace the code snippet. Finally, the replaced text will be input to GPT. So, theoretically, you can accomplish all interactions between Zotero and GPT using command tags.
How to navigate historical chats
Press the up (↑) and down (↓) keys on the keyboard to navigate.