No description
Find a file
2022-08-17 20:44:46 +09:00
.github/workflows chore: update release.yml 2022-08-17 20:44:45 +09:00
.husky change: defaultFrontmatterKeyType from snake to camel 2022-08-17 20:42:51 +09:00
.vscode chore: add vscode settings.json 2022-08-14 17:52:57 +09:00
pages add: installation link in gh-pages 2022-08-17 20:44:45 +09:00
src refactor: google book response 2022-08-17 20:44:46 +09:00
.editorconfig Initial commit 2022-04-07 14:15:50 +09:00
.eslintignore Initial commit 2022-04-07 14:15:50 +09:00
.eslintrc chore: update eslint 2022-08-14 17:21:28 +09:00
.gitignore chore: add vscode settings.json 2022-08-14 17:52:57 +09:00
.npmrc chore: change use of npm to yarn 2022-08-14 17:10:50 +09:00
.nvmrc chore: add .nvmrc file 2022-04-30 16:56:35 +09:00
.prettierignore chore: install prettier-cli 2022-08-14 17:36:23 +09:00
.prettierrc chore: install prettier-cli 2022-08-14 17:36:23 +09:00
.versionrc chore(release): 0.0.2 2022-04-07 14:39:30 +09:00
CHANGELOG.md chore(release): 0.5.1 2022-08-17 20:44:45 +09:00
esbuild.config.mjs chore: apply minify build 2022-08-17 20:44:46 +09:00
jest.config.js update: jest.config.js 2022-08-14 11:47:00 +09:00
LICENSE.txt Create LICENSE.txt 2022-04-10 17:47:33 +09:00
manifest.json chore(release): 0.5.1 2022-08-17 20:44:45 +09:00
package.json add: installation link in gh-pages 2022-08-17 20:44:45 +09:00
README.md add: installation link in gh-pages 2022-08-17 20:44:45 +09:00
styles.css refactor: settings.ts 2022-08-15 00:25:31 +09:00
tsconfig.json move: CursorJumper in utils folder 2022-08-17 20:44:45 +09:00
version-bump.mjs Initial commit 2022-04-07 14:15:50 +09:00
versions.json Initial commit 2022-04-07 14:15:50 +09:00
yarn.lock add: installation link in gh-pages 2022-08-17 20:44:45 +09:00

Obsidian Book Search Plugin

GitHub Workflow Status GitHub release (latest SemVer)

Easily create book notes.

Demo

May-05-2022 18-01-01

If this plugin helped you and you wish to contribute :)

Buy Me A Coffee


Description

Use to query book using :

  • A book title, author, publisher or ISBN (10 or 13).

Use Google Books API to get the book information.

블로그: 옵시디언 책 검색 플러그인 사용방법


How to install

Click the link to install the Book Search plugin: Install Link

Or, Search in the Obsidian Community plugin. And install it.


How to use

  1. Set the folder to new file location in plugin options. And you can also add a frontmatter that is inserted when creating a note.

  2. Excute the command "Create new book note".

  3. Search for books by keywords.

  4. Select the book from the search results.

  5. Voila! A note has been created.


How to use settings

(Deprecated) Text to insert into front matter

You can add the following to the default Front Matter, or create a new Front Matter with the structure you want.


(Deprecated) Text to insert into content

You can add text to the content for Dataview inline metadata.


Please use the template file described below.


Example template

Please also find a definition of the variables used in this template below (see: Template variables definitions).

---
tag: 📚Book
title: "{{title}}"
author: [{{author}}]
publisher: {{publisher}}
publish: {{publishDate}}
total: {{totalPage}}
isbn: {{isbn10}} {{isbn1#template-variable-definition
cover: {{coverUrl}}
status: unread
created: {{DATE:YYYY-MM-DD HH:mm:ss}}
updated: {{DATE:YYYY-MM-DD HH:mm:ss}}
---

![cover|150]({{coverUrl}})

# {{title}}


Dataview rendering

Here is the dataview query used in the demo

# 📚 My Bookshelf

```dataview
TABLE WITHOUT ID
	status as Status,
	rows.file.link as Book
FROM  #📚Book
WHERE !contains(file.path, "Templates")
GROUP BY status
SORT status
```

## List of all books

```dataview
TABLE WITHOUT ID
	status as Status,
	"![|60](" + cover + ")" as Cover,
	link(file.link, title) as Title,
	author as Author,
	join(list(publisher, publish)) as Publisher
FROM #📚Book
WHERE !contains(file.path, "Templates")
SORT status DESC, file.ctime ASC
```

The banner at the top of the document is rendered using Obsidian-banners plugin.


Template variables definitions

Please find here a definition of the possible variables to be used in your template. Simply write {{name}} in your template, and replace name by the desired book data, including:

name description
title The title of the book.
author The name of the book author. It can be multiple people.
category book category
publisher The publisher of the book.
totalPage The total number of pages in the book.
coverUrl Book cover image URL.
publishDate The year the book was published.
isbn10 ISBN10
isbn13 ISBN13

License

Obsidian Book Search Plugin is licensed under the GNU AGPLv3 license. Refer to LICENSE for more information.


Contributing

Feel free to contribute.

You can create an issue to report a bug, suggest an improvement for this plugin, ask a question, etc.

You can make a pull request to contribute to this plugin development.