Scarvy / ghostreader-prompts

A collection of user-created prompts for Readwise Reader's "Copilot of Reading" feature Ghostreader

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ghostreader Prompts

A collection of user-created prompts for Reader's "Copilot of Reading" feature - Ghostreader πŸ‘»πŸ€“.

ghostreader-prompt

Purpose ✍️

To collect, share, and collaborate on prompts.

About using custom prompts in Ghostreader πŸ‘‡

Directly from Readwise Reader:

{#- ⚠️ Custom prompts are an advanced feature. ⚠️ Custom prompts enable you to interface with GPT-3 directly using variables for content contained in the document such as the title, the whole text, the focused paragraph, a text selection, your highlights, and more. This is done using the Jinja templating language.

See reference documentation for more instructions on how to use custom Ghostreader prompts. The default example below writes a haiku based on your highlights. -#}

I took the following highlights while reading a document titled {{ document.title }}:

""" {% for highlight in highlights %} {{ highlight.content }} {{ "\n\n" }} {% endfor %} """

Write a haiku.

For more information on custom prompts and the Ghostreader feature in general. Please refer to this newsletter here.

Folder Structure πŸ—‚οΈ

The prompts are organized into a single folder called "prompts" with sub-folders organized based on their general purpose like "summary", "questions", and "poems". I imagine these sub-folders will expand and change as individuals contribute more prompts to the project.

I'm still working on how best to organize the repository for ease of discoverability. If you have any suggestions please on how best to organize everything please make a comment in the "Discussions" section of this project or in the Reader Discord channel "#ghostreader-gpt".

User-Guide πŸ“„

Under the "Wiki" tab, there is a user-guide with descriptions of parameters to help craft prompts.

Contributing πŸ™

Contributions are welcome!

As of right now, please paste your prompt into a text file (ext ".txt") and follow these steps:

Steps:

  1. Name file with ".txt' extension and give it a descriptive title that is not already taken like short-summary-documents.txt

  2.  {#-
     author: <author's name>
     source: <url to source (if applicable)>
     -#}
    
     <prompt goes here>
    

About

A collection of user-created prompts for Readwise Reader's "Copilot of Reading" feature Ghostreader

License:MIT License