mirror of
https://github.com/kvasonaft/fb2-reader.git
synced 2026-07-22 08:31:14 +00:00
No description
0.1.2 required Obsidian 1.13.0 for the declarative settings API, but 1.13.x is currently Catalyst-only. Restore the imperative settings-tab fallback so the plugin works on the latest free release (1.12.7); the declarative path still takes over on 1.13+. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> |
||
|---|---|---|
| src | ||
| .gitignore | ||
| LICENSE | ||
| manifest.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| styles.css | ||
| tsconfig.json | ||
| versions.json | ||
FB2 Reader
An Obsidian plugin for reading FictionBook (.fb2) files directly in your vault. Works on desktop and mobile.
Features
- Reader view. Open a
.fb2file and it renders as a formatted book: cover, title page, authors, annotation, chapters, poems, quotes, footnotes, images, and tables. - Table of contents. A side panel lists the chapters of the active book; click a chapter to scroll to it.
- Reading position. The plugin remembers where you stopped in each book (up to 300 books) and takes you back there when you reopen it.
- Appearance settings. Theme (light / dark / sepia or follow Obsidian), font family, font size, line height, text color, and optional drop caps.
- Encoding detection. Older FB2 books in windows-1251 and other legacy encodings are decoded automatically.
Usage
Put a .fb2 file anywhere in your vault and click it — it opens in the reader. Use the Open table of contents command (or switch to a reader tab) to show the chapter panel.
Note: zipped books (.fb2.zip) are not supported — unpack them to plain .fb2 first. Obsidian identifies files by their final extension only, so claiming .zip would hijack every archive in the vault.
Installation
From community plugins
Search for FB2 Reader in Settings → Community plugins (once the plugin is accepted into the catalog).
Manual
- Download
main.js,manifest.json, andstyles.cssfrom the latest release. - Copy them into
<your vault>/.obsidian/plugins/fiction-book-reader/. - Reload Obsidian and enable FB2 Reader in Settings → Community plugins.
Development
npm install
npm run dev # watch mode, rebuilds main.js on change
npm run build # typecheck + production build
The entire plugin lives in src/main.ts; esbuild bundles it into main.js.