FB2 Booker
unlistedby Your Name
Convert FB2 books into Obsidian notes with page navigation
FB2 Booker Plugin for Obsidian
Convert FB2 (FictionBook 2.0) ebooks into Obsidian notes with page navigation buttons.
Features
- ๐ Import FB2 books into Obsidian
- ๐ Automatic book splitting into pages
- ๐ Navigation buttons to move between pages
- ๐ Table of contents with quick access to all pages
- โ๏ธ Configurable folders for source files and converted notes
- ๐๏ธ Automatic folder creation on first launch
Installation
From Obsidian Community Plugins (Recommended)
- Open Settings in Obsidian
- Go to Community plugins and disable Safe mode
- Click Browse and search for "FB2 Booker"
- Click Install, then Enable
Manual Installation
- Download the latest release from GitHub
- Extract the files into
<vault>/.obsidian/plugins/fb2-booker/ - Reload Obsidian
- Enable the plugin in Settings โ Community plugins
Usage
Configuration
Go to Settings โ FB2 Booker and configure:
- Source folder for FB2 books - Folder where your FB2 files are located (default:
Books/FB2) - Output folder for converted notes - Folder where converted book notes will be saved (default:
Books/Converted) - Words per page - Approximate number of words per note page (default: 500)
Importing Books
- Place FB2 files in the source folder (folders will be created automatically on first launch if they don't exist)
- Use one of these methods:
- Click the book icon ๐ in the left ribbon
- Open Command Palette (Ctrl/Cmd+P) and select Import FB2 books from source folder
Note: On first import, the folders
Books/FB2andBooks/Convertedwill be created automatically if they don't exist in your vault.
Note Structure
After import, a folder is created for each book with the following structure:
Books/Converted/
โโโ Book Title/
โโโ 00 - Book Title.md (table of contents)
โโโ Page 1.md
โโโ Page 2.md
โโโ Page 3.md
โโโ ...
Each page contains:
- Navigation buttons at the top and bottom
- Page content
- Links to previous/next pages and table of contents
FB2 Format
The plugin supports the standard FB2 (FictionBook 2.0) format. It extracts:
- Book title
- Author name
- Text content with sections and paragraphs
- Section headings
Technical Details
- isDesktopOnly: true (plugin uses file system operations and works only on desktop)
- Minimum Obsidian version: 0.15.0
- Uses native browser DOMParser for XML parsing
- No external dependencies or network requests
Development
Install Dependencies
npm install
Development Build (with watch mode)
npm run dev
Production Build
npm run build
Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
Support
If you encounter any issues or have questions, please open an issue on GitHub.
License
0-BSD
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.