FB2 Booker

unlisted

by Your Name

Convert FB2 books into Obsidian notes with page navigation

Updated 2mo ago0BSD
View on GitHub

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)

  1. Open Settings in Obsidian
  2. Go to Community plugins and disable Safe mode
  3. Click Browse and search for "FB2 Booker"
  4. Click Install, then Enable

Manual Installation

  1. Download the latest release from GitHub
  2. Extract the files into <vault>/.obsidian/plugins/fb2-booker/
  3. Reload Obsidian
  4. 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

  1. Place FB2 files in the source folder (folders will be created automatically on first launch if they don't exist)
  2. 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/FB2 and Books/Converted will 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.