search

Mitra98t / vault2book-plugin

MIT License
24 stars 0 forks source link

readme

Obsidian 2 Book

This plugin convert your Obsidian vault (or a portion of the vault) into a single file using links. The file can then be exported to PDF creating a book.

Installation

Note: This plugin is not yet available in the official Obsidian plugin library. You can install it manually by following the instructions below.

  1. Install Node.js
  2. Install Obsidian
  3. Enable third party plugin in Obsidian settings: Settings > Community Plugins > Enable
  4. Navigate to the plugins folder on your machine: VaultFolder/.obsidian/plugins/ (if the folder doesn't exist, create it)
  5. Clone the Obsidian 2 Book repository inside the plugin folder
  6. Run npm install inside the repository folder
  7. Run npm run build inside the repository folder
  8. In Obsidian, make sure the plugin is enabled in Settings > Third-party plugin > Vault 2 Book > Enable

Usage

Generate a book from your Obsidian vault by running the command Vault 2 Book: Generate book from the entire vault from the command palette (Ctrl/Cmd + P). The book will be generated in the root of your vault.

Generate a book from a specific folder in your vault by running the command Vault 2 Book: Generate a book from a specified folder from the command palette (Ctrl/Cmd + P). The book will be generated in the root of your vault. (You should be able to navigate to the folder you want to generate the book from directly inside the command palette.)

The ribbon icon can be used as an alternative to the Generate a book from a specified folder command.

Remove every book generated by this plugin by running the command Vault 2 Book: Remove all generated books from vault from the command palette (Ctrl/Cmd + P). (A book is identified by containing this comment: <!--book-ignore-->)

Configuration

You can configure the plugin by going to Settings > Community plugins > Vault 2 Book > Settings.

TODO