Skip to content
Scott Carvalho edited this page Apr 9, 2024 · 9 revisions

Note

Readwise released an official guide. Still a work in progress.

Welcome to the Ghostreader Guide 📓!

Parameters

A list of the parameters you can use to create custom prompts for Ghostreader 👻 📚.

Selection

  • {{ selection.raw }} – Whatever text was selected, focused, or highlighted when you invoked Ghostreader.
  • {{ selection.sentence }} – If you had less than a sentence selected (eg just a word), this will expand to the surrounding sentence.
  • {{ selection.paragraph }} – If you had less than a paragraph selected (eg just a sentence), this will expand to the surrounding paragraph.

Document

  • {{ document.content }} – The full content of the document.
  • {{ document.title }} – The title of the document.

Highlight(s)

  • {{ highlights }} - The list of highlights of the document.

Other

  • {{ central_sentences }} - parameter condenses long documents into key sentences for a succinct summary.
  • {{ count_tokens }} - The number of tokens.

More on the "central_sentences" parameter

"The first IF statement checks to see if the document is longer than 1,000 tokens (a token is a language model concept). If it is, then it reduces the document content to the max allowable tokens by extracting an array of key sentences (central_sentences, which uses more AI voodoo magic) from the text and then concatenating them into a single string (join('\n\n')). If it's not too long, then the whole document content is passed." - Daniel Doyon Reader Newsletter #23

Examples 🤔

  • List the highlighted content:
{% for highlight in highlights %}
    {{ highlight.content }}

List of Official Ghostreader Prompts:

  • Ask the document a question
  • Summarize the document
  • Highlight the document
  • Generate thought-provoking questions
  • Generate Q&A pairs based on your highlights