Skip to content

Commit a8be938

Browse files
committed
Updated readme and package.json with description of the repository and installation instructions
1 parent ca3fc92 commit a8be938

File tree

2 files changed

+25
-2
lines changed

2 files changed

+25
-2
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
> [!INFO]
2+
>
3+
> This is a patched version of the Obsidian plugin [aidenlx/alx-folder-note](https://github.com/aidenlx/alx-folder-note)
4+
>
5+
> The fix addresses the problem reported under: https://github.com/aidenlx/alx-folder-note/issues/134
6+
>
7+
> The source of the problem are breaking changes introduced in Obsidian 1.5.4 in File Explorer.
8+
> They basically renamed the internal field FileExplorerView.fileExplorer to .view thus impacting
9+
> the (backward) compatibility with this plugin.
10+
>
11+
> My plugin [SebastianMC/obsidian-custom-sort](https://github.com/SebastianMC/obsidian-custom-sort) was also affected.
12+
> I invested my time to track back via reverse engineering that breaking change.
13+
> In result I was able to apply relevant fix to my plugin.
14+
> This forked repo of [aidenlx/alx-folder-note](https://github.com/aidenlx/alx-folder-note) applies exactly the same fix to the plugin.
15+
>
16+
> If you want to install the patched version there are two basic options:
17+
> - install from this (forked) repository via Obsidian BRAT plugin, or
18+
> - download this repository and build it by yourself:
19+
> - command: `npm install`
20+
> - command: `npm run build`
21+
> - then copy the `build/main.js` to your vault folder, overriding the `main.js` of the original plugin
22+
>
23+
124
# AidenLx's Folder Note
225

326
Add description, summary and more info to folders with folder notes.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@aidenlx/folder-note",
2+
"name": "@aidenlx/folder-note-patched",
33
"version": "0.16.5",
4-
"description": "Add description, summary and more info to folders with folder notes.",
4+
"description": "@aidenlx/folder-note plugin patched for the breaking changes in Obsidian 1.5.4 (and newer)",
55
"scripts": {
66
"build": "cross-env BUILD=production node esbuild.config.mjs"
77
},

0 commit comments

Comments
 (0)