Release Notes
Table of contents
Overview
The Obsidian Books Vault is an Obsidian vault containing book descriptions in markdown format. It can be viewed using any markdown viewer (e.g. almost any browser) but if Obsidian is used then many additional features will be available including queries using the Dataview plugin for Obsidian.
The Obsidian-Books-Vault repository reflects the partial contents of my personal library of books, cds, and records. As such, it may be relevant only to a few. However, the process by which this repository was created and curated as well as the tools used in its creation and curation may be useful to a wider audience. I am making it public and freely licensed so that others may examine, adapt, clone, and use in whatever manner they choose. See the description of Process for an overview of the process and tools employed in the creation of this repository.
These are the release notes for Version 1.0.1 Release 1 of the Obsidian Books Vault.
Installation
The Obsidian Books Vault can be installed on Windows, Mac, or Linux. The following installation instructions are for Mac and Linux. Windows users can follow similar steps.
For the optimal experience, open this vault in Obsidian!
- Download the vault
- Open the vault in Obsidian via "Open another vault -> Open folder as vault"
- Trust us. :)
- When Obsidian opens the settings, verify that the "Dataview", "Excalidraw", and "Excalibrain" plugins are enabled
- Done! The Obsidian Books Vault is now available to you in its purest and most useful form!
Download the release archive
Those familiar with wget can download this release from the command line with:
wget --quiet -O ~/Downloads/Obsidian-Books-Vault-v1.0.1r1.tar.gz \
https://github.com/doctorfree/Obsidian-Books-Vault/archive/refs/tags/v1.0.1r1.tar.gzExtract the release archive
Currently release archives are available in either ZIP or compressed tar archive format.
To extract the ZIP archive:
cd /path/to/your/vaults # e.g. `cd ~/Documents/Obsidian`
unzip /path/to/Obsidian-Books-Vault-1.0.1r1.zipTo extract the compressed tar archive:
cd /path/to/your/vaults # e.g. `cd ~/Documents`
tar xf /path/to/Obsidian-Books-Vault-1.0.1r1.tar.gzOnce extracted, the Obsidian Books Vault is now available in /path/to/your/vaults/Obsidian-Books-Vault-1.0.1r1/.
The downloaded archive can be deleted:
rm -f /path/to/Obsidian-Books-Vault-1.0.1r1.zipor
rm -f /path/to/Obsidian-Books-Vault-1.0.1r1.tar.gzConfiguration
The Obsidian Books Vault is pre-configured for use with Obsidian. Install Obsidian for your platform by clicking the appropriate installation link at the Obsidian website. Obsidian is available for Windows, Mac, and Linux as well as mobile devices.
Add a new vault in Obsidian with Open folder as vault and navigate to the Obsidian-Books-Vault-1.0.1r1 extracted folder. When prompted, Trust and enable the Dataview plugin if it is not already enabled.
The Obsidian Books Vault includes the Doctorfree Obsidian theme. Enable this Obsidian theme in Obsidian by visiting Settings -> Appearance and selecting Doctorfree from the dropdown in the Themes section.
Obsidian is required for some features but is not necessary to view the Obsidian Books Vault. Any markdown viewer/editor can be used. If the Obsidian Books Vault is extracted into a website folder, it can be viewed using most browsers.
Book Queries
The Obsidian Books Vault has been curated with metadata allowing queries to be performed using the Obsidian Dataview plugin. Sample queries along with the code used to perform them can be viewed in the Books Queries document.
Removal
To remove the Obsidian Books Vault simply remove the extracted folder and its contents:
cd /path/to/your/vaults # e.g. `cd ~/Documents/Obsidian`
rm -rf Obsidian-Books-Vault-1.0.1r1Support
Support the development and improvement of the Obsidian Books Vault by sponsoring the Projects of Doctorfree.
Changelog
View the full changelog for this release at https://github.com/doctorfree/Obsidian-Books-Vault/blob/v1.0.1r1/CHANGELOG.md