You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-2Lines changed: 19 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,25 @@ This plugin is designed to generate thumbnails for notes in the [bases](https://
4
4
The plugin is capable of rendering thumbnails in two different ways:
5
5
- A faster, less "as-seen" render using CodeMirror's `MarkdownRenderer`.
6
6
- A slower, more "as-seen" render by physically rendering the note and capturing its contents.
7
-
8
-
The plugin is capable of automatically generating thumbnails when the files that appear in bases change, when new cards views are added, etc.
7
+
## Installtion & Usage
8
+
1. This plugin is not yet publicly listed (coming soon!). For now, you can use [BRAT](https://github.com/TfTHacker/obsidian42-brat) and ensure it is installed and enabled.
9
+
2. Enter the options/settings for BRAT and add a new beta plugin.
10
+
3. Use `infinity6542/note-thumbnails` as the repository.
11
+
4. Select "Latest version".
12
+
5. Ensure "Enable after installing the plugin" is ticked and click on "Add plugin".
13
+
6. You're done!
14
+
### Trying It Out
15
+
1. Create some files! Any standard Markdown (e.g. highlights, bold, italics, etc.) syntax is currently supported. Images, canvases, etc. have not yet been tested.
16
+
2. Create a base file. You can do this by right-clicking on the file explorer (not on a file please) and choosing "Create base".
17
+
3. Let's create some filters! Click "Filters" in the top left of the active leaf and click the "All views" dropdown.
18
+
4. Ensure that the filter is set to "All the following are true" and create one new filter so that there are two.
19
+
5. Click the code icon to the left of both filters, then copy paste these into both (one per filter): `!file.name.contains(".jpg")!file.name.contains(".jpg")` and `!file.name.contains(".base")`. Your filters are complete!
20
+
6. Let's generate the thumbnails now. Open the command palette (defualt keybind is `ctrl+p`) and search for "Note Thumbnails: Generate thumbnails". Either click it or press enter on your keyboard when it's highlighted.
21
+
7. Now we need to view your thumbnails. Your default view should be a table. Let's change that! Go to the top left and click the view switcher (it should say "Table" currently).
22
+
8. Click the right arrow on the "Table" view.
23
+
9. Click the "Layout" dropdown and select "Cards".
24
+
10. Click "Image property" and choose "thumbnail". Adjust the parameters as you please!
25
+
11. You're done! If the thumbnails don't properly fit the card, simply regenerate the thumbnails (see step 6).
9
26
## Bugs, Issues and Feature Requests
10
27
> [!IMPORTANT]
11
28
> The GitHub repository is a read-only mirror. Please make any bug reports or feature requests in the [GitLab repository](https://gitlab.com/Infinity6542/note-thumbnails).
0 commit comments