Readwise

https://docs.readwise.io/readwise/docs
Admin
Readwise is a digital tool that helps you retain and organize valuable insights from your reading...
Tokens:26,447
Snippets:285
Trust Score:9.9
Update:7 months ago
Show doc for...
Tokens:
Raw
### Example Readwise Search URL

Source: https://docs.readwise.io/readwise/docs/faqs/finding-highlights

An example demonstrating how to use the Readwise search URL parameter with specific keywords. This shows the format for querying content, such as finding a specific song lyric.

```url
readwise.io/search?q=never+gonna+give+you+up
```

--------------------------------

### Readwise Keyword Search Example

Source: https://docs.readwise.io/readwise/docs/faqs/finding-highlights

Illustrates how Readwise prioritizes search results based on matches in both highlight text and metadata. This example shows a query for highlights related to 'Taleb' and 'Harvard', prioritizing results where both terms appear in the author field and highlight text, respectively.

```text
taleb harvard
```

--------------------------------

### Customized Readwise Highlight Template with Date (Jinja2)

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/tana

An example of a customized Jinja2 template for Readwise highlights that adds the date the highlight was made as a new field, in addition to the default fields.

```jinja2
{{ highlight_text }} #highlight
{% if highlight_location_url %}
    Readwise Location:: {{highlight_location_url}}
{% endif %}
{% if highlight_tags %}
    Topics:: {% for t in highlight_tags %} {{t}}{% endfor %}
{% endif %}
{% if highlight_note %}
    Notes:: {{ highlight_note }}
{% endif %}
{% if highlight_date %}
    Date Highlighted:: {{ highlight_date }}
{% endif %}


```

--------------------------------

### Customize Metadata Template (Jinja2)

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/obsidian

Shows how to customize the metadata section of Obsidian exports using Jinja2. Includes conditional display of cover image, author, title, category, tags, and URL, with examples for adding emojis to categories.

```jinja2
{% if image_url -%}
![rw-book-cover]({{image_url}})
{% endif -%}<br>
## Metadata
- Author: {% if author %}[[{{author}}]]{% endif %}
- Full Title: {{full_title}}
- Category: #{{category}}
{% if document_tags -%}
- Document Tags: {% for tag in document_tags %}[[{{tag}}]] {% endfor %}
{% endif -%}
{% if url -%}
- URL: {{url}}
{% endif -%}


```

```jinja2
Category: #{{category}}{{ " 📚" if category == "books"}}{{" 📰" if category == "articles"}}{{" 🐦" if category == "tweets"}}{{" 🎙" if category == "podcasts"}}

```

--------------------------------

### Customized Readwise Note Title with Author (Jinja2)

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/tana

An example of a customized Jinja2 template for Readwise note titles that prepends the author's name before the title and includes the category as a tag.

```jinja2
{{author}} - {{title}} #{{category}}

```

--------------------------------

### Customize Readwise Highlight Header Template

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/roam

Shows how to format the header text that appears above synced highlights. It includes conditional logic to differentiate between newly synced pages and pages with new highlights, and demonstrates how to remove date backlinking.

```Jinja2
{% if is_new_page %}
Highlights first synced by #Readwise [[{{date}}]]
{% elif has_new_highlights %}
New highlights added [[{{date}}]] at {{time}}
{% endif %}

```

```Jinja2
Highlights synced by #Readwise: {{date}} at {{time}}

```

--------------------------------

### Default Readwise Highlight Formatting Template (Jinja2)

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/tana

The default Jinja2 template for formatting individual highlights in Tana. It includes the highlight text, a #highlight tag, and conditionally adds the location URL, tags, and notes if they exist.

```jinja2
{{ highlight_text }} #highlight
{% if highlight_location_url %}
    Readwise Location:: {{highlight_location_url}}
{% endif %}
{% if highlight_tags %}
    Topics:: {% for t in highlight_tags %} {{t}}{% endfor %}
{% endif %}
{% if highlight_note %}
    Notes:: {{ highlight_note }}
{% endif %}


```

--------------------------------

### Customize Highlight Header Template (Jinja2)

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/obsidian

Illustrates customizing the header for highlight sections in Obsidian exports using Jinja2. Supports conditional headers for new pages versus appended highlights, and formatting dates for daily notes.

```jinja2
{% if is_new_page %}
## Highlights
{% elif has_new_highlights -%}
## New highlights added {{date|date('F j, Y')}} at {{time}}
{% endif -%}


```

```jinja2
{% if is_new_page %}
## Highlights
{% elif has_new_highlights -%}
## New highlights added {{date|date('Y-m-d')}} at {{time}}
{% endif -%}


```

--------------------------------

### Customize Category Tag with Emojis

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/logseq

This example shows how to append specific emojis to the category tag based on the category type. It uses inline-if statements within the Jinja2 template to add '📚' for books, '📰' for articles, '🐦' for tweets, and '🎙' for podcasts.

```jinja2
Category: #{{category}}{{ " 📚" if category == "books"}}{{ " 📰" if category == "articles"}}{{ " 🐦" if category == "tweets"}}{{ " 🎙" if category == "podcasts"}}

```

--------------------------------

### Export Full Text of Documents to Obsidian

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/obsidian

Enables exporting the complete text of Reader documents to Obsidian. This creates a secondary file for each document containing its full content, linked from the original highlight file for organization.

```text
Setting: Export All Reader Documents
Value: ON
```

--------------------------------

### Format Individual Highlights in Logseq Export

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/logseq

This snippet details how to format the export of individual highlights. It includes the highlight text, an optional hyperlink to the original highlight with location details, and conditionally displays tags and notes as sub-bullets. It utilizes Jinja2 for conditional rendering and formatting.

```jinja2
{{ highlight_text }}
{% if highlight_location and highlight_location_url %} ([{{highlight_location}}]({{highlight_location_url}})){% elif highlight_location %} ({{highlight_location}}){% endif %}
    {% if highlight_tags %}
    **Tags**: {% for tag in highlight_tags %}#[[{{tag}}]] {% endfor %}
    {% endif %}
    {% if highlight_note %}
    **Note**: {{ highlight_note }}
    {% endif %}

```

--------------------------------

### Consolidated Highlights Template - Readwise

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/roam

This template is designed for a workflow where all highlights are synced to a single page, regardless of their source. It includes the highlight text, location, category, title, author, tags, and notes, allowing for a consolidated view.

```jinja2
{{ highlight_text }}
{% if highlight_location and highlight_location_url %} ([{{highlight_location}}]({{highlight_location_url}})){% elif highlight_location %} ({{highlight_location}}){% endif %}
    Category: [[{{ category }}]]
    Title: [[{{title}}]]
    Author: [[{{author}}]]
    {% if highlight_tags %}
    **Tags**: {% for tag in highlight_tags %}#[[{{tag}}]] {% endfor %}
    {% endif %}
    {% if highlight_note %}
    **Note**: {{ highlight_note }}
    {% endif %}


```

--------------------------------

### Customize Readwise Page Metadata Template

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/roam

Illustrates how to customize the metadata displayed for imported content. It includes default metadata fields like Author, Full Title, and Category, and shows advanced customization with conditional logic for different content types and adding TODOs.

```Jinja2
Author:: [[{{author}}]]
Full Title:: {{full_title}}
Category:: #{{category}}
{% if document_tags %}Document Tags:: {% for tag in document_tags %}#{{tag}} {% endfor %} {% endif %}
{% if url %}URL:: {{url}}{% endif %}
{% if image_url %}![]({{image_url}}){% endif %}

```

```Jinja2
{% if category == "tweets" %}
#twitter 🐦
{% elif category == "books" %}
{{"{{"}}[[TODO]]{{"}} "}} #toprocess process & summarize the highlights from this book
{% else %}
This is a podcast/article
{% endif %}
Author:: [[{{author}}]]
Full Title:: {{full_title}}
Category:: #{{category}}{{ " 📚" if category == "books"}}{{" 📰" if category == "articles"}}{{" 🐦" if category == "tweets"}}{{" 🎙" if category == "podcasts"}}
{% if document_tags %}Document Tags:: {% for tag in document_tags %}#{{tag}} {% endfor %} {% endif %}
{% if url %}URL:: {{url}}{% endif %}
{% if image_url %}![]({{image_url}}){% endif %}

```

--------------------------------

### Default Highlight Template - Readwise

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/roam

This is the default template for formatting individual highlights in Readwise. It includes the highlight text, optional location information, tags, and notes. Customization allows for altering the display order and format of these elements.

```jinja2
{{ highlight_text }}
{% if highlight_location and highlight_location_url %} ([{{highlight_location}}]({{highlight_location_url}})){% elif highlight_location %} ({{highlight_location}}){% endif %}
    {% if highlight_tags %}
    **Tags**: {% for tag in highlight_tags %}#[[{{tag}}]] {% endfor %}
    {% endif %}
    {% if highlight_note %}
    **Note**: {{ highlight_note }}
    {% endif %}


```

--------------------------------

### Format Readwise Highlights with Jinja2

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/obsidian

This template snippet demonstrates how to format exported highlights from Readwise. It includes the highlight text, optional location and URL, and conditionally adds tags and notes as sub-bullets. It utilizes Jinja2 templating for conditional logic and loops.

```jinja2
- {{ highlight_text }}{% if highlight_location and highlight_location_url %} ([{{highlight_location}}]({{highlight_location_url}})){% elif highlight_location %} ({{highlight_location}}){% endif %}{% if highlight_tags %}
    - Tags: {% for tag in highlight_tags %}[[{{tag}}]] {% endfor %}{% endif %}{% if highlight_note %}
    - Note: {{ highlight_note }}{% endif %}

```

--------------------------------

### Format Highlight Header in Logseq Export

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/logseq

This snippet defines the header text for synced highlights. It conditionally displays different headers based on whether it's a new page or if there are new highlights. It includes the sync date and time, and demonstrates how to format the date using Jinja2 filters to match daily note conventions.

```jinja2
{% if is_new_page %}
Highlights first synced by [[Readwise]] [[{{date}}]]
{% elif has_new_highlights %}
New highlights added [[{{date}}]] at {{time}}
{% endif %}

```

```jinja2
{{date|date('Y-m-d')}}

```

--------------------------------

### Readwise Search URL Parameter

Source: https://docs.readwise.io/readwise/docs/faqs/finding-highlights

Access Readwise search results directly using a URL parameter. This allows for integration with browser search shortcuts and other tools. The query parameter 'q' accepts keywords, with spaces automatically converted to '+'.

```url
readwise.io/search?q={query}
```

--------------------------------

### Customize Readwise Page Title Template

Source: https://docs.readwise.io/readwise/docs/exporting-highlights/roam

Demonstrates how to modify the default Readwise page title template. It shows the use of the `{{ title }}` variable and how to prepend category information. The `{{ category }}` variable is used to dynamically set the title based on content type.

```Jinja2
{{ title }} (highlights)

```

```Jinja2
{{category}}/{{title}}

```

```Jinja2
{{"All Highlights"}}

```
Tokens:
Raw