Banana Reader

by banana
5
4
3
2
1
Score: 31/100

Description

Desktop reading companion for Markdown, original PDFs and EPUB, with configurable AI, anchored annotations and note export.

Reviews

No reviews yet.

Stats

1
stars
163
downloads
0
forks
31
days
9
days
9
days
10
total PRs
0
open PRs
0
closed PRs
10
merged PRs
1
total issues
1
open issues
0
closed issues
107
commits

Latest Version

9 days ago

Changelog

Mobile reading UI and a WeRead shelf you can find.

  • The selection menu keeps one row: colours and line styles side by side, each with its own glyph, plus quick actions and a copy button.
  • The top and bottom bars hide while scrolling and come back on a tap.
  • The phone question box drops the model picker, so the input gets the room.
  • The bookshelf's 「微信读书」 tab no longer hides when no API key is configured; the panel links straight to the key form.

Desktop-only community build (gloss-reader). The phone build shares this version number and differs only by isDesktopOnly: false; it is not published as a community release.

README file from

Github

Banana Reader

Read, annotate, and ask questions alongside your documents in Obsidian.

Banana Reader turns Markdown, PDF, and EPUB files into a focused reading workspace. Highlight a passage, add your thoughts, ask a model about it, and return to the original text from the answer.

Simplified Chinese · Install · User guide (Chinese) · Report an issue

Available in the Obsidian community plugin directory. Open Settings → Community plugins → Browse, search for Banana Reader, install it, and select Enable.

Install and enable · Features · Get started · Author

Features

  • Read in context: open Markdown, EPUB, or PDF in a dedicated reader with a table of contents and adjustable appearance. EPUB contents include nested chapters and estimated page numbers; PDFs can use text reflow or original pages.
  • Highlight and annotate: mark text in different styles and colors, write notes, and revisit them in the reading notebook.
  • Write your own notes: use the reader toolbar, the button beside an AI answer, or Shift + N to save a thought without selecting text. Review, edit, and export it from the notebook.
  • Ask about a passage: explain, translate, or ask your own questions; follow citations back to the source.
  • Choose your model: use an OpenAI-compatible, Anthropic, or Gemini API, or a locally authenticated Codex, Claude, or Pi CLI. Optional embeddings support retrieval across longer texts.
  • Keep your notes: export excerpts, annotations, and conversations as a new Markdown note with links to the source.
  • Find your next read: browse the vault bookshelf, or search and download books through a configured Z-Library mirror using your own account.
  • Browse your WeRead shelf: configure your WeRead API key under Book sources, then switch the bookshelf to your WeChat Reading shelf (covers, progress badges, categories); open a local copy you already have, hand a title to Z-Library search, or jump back to WeRead. Each book also opens its own highlights and thoughts, grouped by chapter, inside the bookshelf card. Shelf metadata and your notes only; book content stays in WeRead or local files.
  • Discover books: explore and filter Hacker Books recommendations, then search for a title on Z-Library from its details.
  • Take over the reading view: turn on Settings → Banana Reader → Appearance → Default reading → Take over the reading view, and clicking Obsidian's own reading-view button opens that note in Banana Reader instead. Notes in protected folders are never taken over, and the button still returns to editing as usual.

Installation

The current community release is desktop-only and requires Obsidian 1.11.4 or later. The interface supports English and Simplified Chinese.

  1. In Obsidian, open Settings → Community plugins. If prompted, turn on community plugins first.
  2. Select Browse, search for Banana Reader by banana, and select Install → Enable. If it is already installed, enable it in the community plugins list.
  3. Open a Markdown, PDF, or EPUB file, then use the Open Banana Reader ribbon button or the Enter immersive reading command.

You can also open the official plugin page, select Add to Obsidian, and install and enable it in Obsidian. Check for updates under Settings → Community plugins.

For manual installation, download main.js, manifest.json, and styles.css from the latest release into <vault>/.obsidian/plugins/gloss-reader/, reload Obsidian, and enable the plugin under Community plugins. Keep your existing data.json and indices/ when updating. If you previously installed the separate banana-reader plugin ID, disable it before enabling this one: never run both IDs at the same time.

Get started

Select text to highlight it, add a note, or ask a question. Open the reading notebook to review your annotations and export them as Markdown.

Reading, highlighting, and export do not require an AI account. For AI features, add a service under Settings → Banana Reader → Model services, select or add a model, and assign it to the task. With LM Studio on the same computer, start its local server, choose OpenAI compatible, and use its displayed base URL (typically http://localhost:1234/v1) and model ID.

For setup details and format limits, see the Chinese user guide.

Privacy and limitations

  • Annotations, conversations, drafts, and progress are stored in the plugin's data.json; optional indexes are stored in indices/. Export creates a new Markdown file. Syncing the plugin folder may sync these files too.
  • API keys are stored in Obsidian SecretStorage when available; otherwise they remain in memory for the session. Requests send the relevant text and question to your chosen model or embedding provider. Google translation, optional web search, and Z-Library connect to their respective services.
  • The WeRead bookshelf sends its API key and shelf requests to WeChat Reading's official agent gateway and fetches covers from its CDN; only your own shelf metadata and your own highlights and thoughts are read. This integration may change or become unavailable as WeRead evolves, and a restricted network may see risk-control errors.
  • Opening book recommendations contacts Hacker Books for its catalog, topics, and covers; search and filtering run locally.
  • PDF text selection requires a text layer; OCR is not included. EPUB requires supported, unencrypted text content. Z-Library is an unofficial integration whose mirrors and availability can change; access only content you are entitled to use.
  • Mobile support is under development. The community release is desktop-only; a local mobile candidate is not a verified mobile release.

Development

npm ci
npm run check

See the development guide for build, test, and release details.

Author

Banana Reader is maintained by banana (TreyDong). The project brings reading, thinking, and note-taking together in Obsidian, with links back to the original text.

Share feedback, ideas, or problems through GitHub Issues.

License and credits

Project code is licensed under MIT. Fonts and dependencies have their own licenses; see third-party notices. Early interaction references include Gloss and Qiaomu Reader.