Code Monkey home page Code Monkey logo

ghostreader-prompts's Introduction

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>
    

ghostreader-prompts's People

Contributors

scarvy avatar

Stargazers

Jimmy Briggs avatar  avatar Fung YIP avatar  avatar  avatar  avatar Yu Sheng Li avatar Akram avatar Jochen Witte avatar Maria Francis Palafox avatar Edson Bittencourt  avatar Fred Bliss avatar AJ King avatar  avatar  avatar  avatar  avatar Michael Seifarth avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.