Merge branch 'main' into beta

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,7 +30,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Plugin information**
 - Version: [e.g. v1.7.30]
-- [ ] Beta version (If it is the beta version also add the beta label)
+- [ ] Beta version
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/label-beta.yml

@@ -0,0 +1,30 @@
+name: Label Beta Issues
+
+on:
+  issues:
+    types: [opened, edited]
+
+jobs:
+  label-beta:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check for Beta Version checkbox
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const betaChecked = context.payload.issue.body.includes("- [x] Beta version");
+
+            if (betaChecked) {
+              const issue_number = context.payload.issue.number;
+              const labels = context.payload.issue.labels.map(label => label.name);
+
+              if (!labels.includes('beta')) {
+                await github.rest.issues.addLabels({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  issue_number: issue_number,
+                  labels: ['beta']
+                });
+              }
+            }

README.md

@@ -3,6 +3,9 @@
 Folder notes is a plugin for the note taking app  [Obsidian](https://obsidian.md/) that lets you attach notes to folders so that you can click on the name of a folder to open the note like in the app [Notion](https://www.notion.so/).
 This plugin has some unique features that separate it from similar "Folder note" plugins like opening folder notes through the path, creating folder notes for every existing folder, templater/template support and more.
 
+Support the development of the plugin
+
+<a href='https://ko-fi.com/D1D1GHGSI' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
 ## Documentation & download link
 The plugin can be downloaded by clicking on https://obsidian.md/plugins?id=folder-notes and then on install. If you need help with the plugin or want to  know what the features are that the plugin has then you can find the documentation at https://lostpaul.github.io/obsidian-folder-notes/.
 
@@ -10,8 +13,5 @@ The plugin can be downloaded by clicking on https://obsidian.md/plugins?id=folde
 
 The easiest option is to install the [BRAT plugin](https://obsidian.md/plugins?id=obsidian42-brat) and then to follow the following guide: https://tfthacker.com/brat-quick-guide & use this link https://github.com/LostPaul/obsidian-folder-notes to install the beta version.
 
-## Support the development of the plugin
-
-<a href='https://ko-fi.com/D1D1GHGSI' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
-
+## Discord server
 [For regular updates on Folder Notes and my other plugins, join the Discord server to get notified and participate in discussions.](https://discord.gg/4UQEDfQmuH)

docs/docs/Features/Command palette commands.md

@@ -1,16 +1,18 @@
 # Command palette commands
 
-## Make current active note a folder note for the folder of the active note
+## Use this file as the folder note for its parent folder
 The note that's currently in focus will be the new folder note for the parent folder of the file.
-## Create folder note with a new folder for the active note in the current folder
+## Make a folder with this file as its folder note
 This command creates a new folder and uses the current file that is in focus as the folder note. The new folder will be in the same folder as the folder the file was in.
-## Create {type} folder note for current folder of active note
+## Create {type} folder note for this folder
 Create a new folder note for the folder of the current file that is in focus. The plugin will not use the file in focus but instead a completely new file.
-## Delete folder note of current folder of active note
-Delete the file of the folder note that is for the folder which the current file in focus is in.
-## Open folder note of current folder of active note
-Open the folder note of the folder that the current file in focus is in.
+## Delete this folder's linked note
+Delete the folder note (only the file itself) of the parent folder of the currently focused file.
+## Open this folder's linked note
+Open the folder note of the parent folder of the currently focused file.
 ## Insert folder overview
 Insert a folder overview in a note. [Click here to know more about a folder overview](./Folder%20overview.md).
-## Create folder note from selected text
+## Edit folder overview
+Edit the default settings or an already created folder overview in the right view. [Click here to know more about a folder overview](./Folder%20overview.md).
+## Create folder note from selection
 Create a new file, a new folder and the file as the folder note. The text that has been selected will be the name of the folder note and the folder.

docs/docs/Features/Exclude folders.md

@@ -1,17 +1,19 @@
 # Exclude folders
-The exclude folder feature can be found in the plugin settings under the tab "Exclude folders".
+The exclude folder feature can be found in the plugin settings under the tab "Exclude folders". Depending on what you exclude a folder from you for example can't open a folder note, the file/folder names don't sync, it doesn't show up in the folder overview and more.
 ## Exclude only one folder
 To only exclude the folder itself and not the sub folders also you have to click on the edit icon and disable include subfolders in the settings.
+
+## How to exclude a folder?
 ### Directly in the settings
 Click on the plus icon, then click on the text input, search a folder name and then select the folder you want to exclude from the list.
-![Video](../assets/xdS3VV7wjIRFNHADE0lx.mp4)
+![Video type:video](../assets/xdS3VV7wjIRFNHADE0lx.mp4)
 ### Through the file explorer
 Click on a folder and then use the context menu and click on "exclude folder from folder notes". The plugin will then apply the [default exclude folder settings](#Default settings) and add it to the excluded folders list.
 ![Screenshot](../assets/Ny4aCJtZStlFmlsN9zp2.png)
 ## Exclude a folder and their subfolders
 To exclude a folder and its subfolders you have to do the same steps as in how to exclude only one folder but enable include subfolders in the settings of an excluded folder.
 ## Exclude multiple folders (with a pattern)
-The pattern only looks at the names of the folders and nothing else. You have to options to exclude folders with a pattern and the first option is to use * before and after the string. The second option is to use a [regex](https://en.wikipedia.org/wiki/Regular_expression).
+The pattern only looks at the names of the folders and nothing else. You have two options to exclude folders with a pattern and the first option is to use * before and after the string. The second option is to use a [regex](https://en.wikipedia.org/wiki/Regular_expression).
 
 To use a regex you have to add "{regex}" at the beginning of the string and everything after it is going to be a regex that matches the folder names.
 
@@ -30,4 +32,7 @@ Test* => matches the name
 Open the exclude folders settings tab and click on a edit button if you've already excluded folders or added patterns to exclude folders.
 ![Screenshot](../assets/mbZW1SXv8o3fKU4g8j3V.png)
 ## Default settings
-To edit the default settings for new excluded folders/patterns you just have to click on one of the "Manage" buttons in the settings that are next to "Exclude folder/pattern default settings".
+To edit the default settings for new excluded folders/patterns you just have to click on one of the "Manage" buttons in the settings that are next to "Exclude folder/pattern default settings".
+
+## Whitelisted folders
+The whitelisted folders overwrite the already excluded folders with options that are the opposite from the excluded folders. For example when you add a pattern to exclude all folders, select to disable opening of folders and then add one specific folder to the whitelist and select "open folder ..." you can only open the specific folder and not all the other folder notes.

docs/docs/Features/File context menu commands.md

@@ -2,5 +2,9 @@
 
 ## Create folder note
 This command creates a new folder and uses the file you clicked on as the folder note. The new folder will be in the same folder as the folder the file was in.
+
+![Example type:video](../assets/videos/Obsidian_Nc9OYAHHT1.mp4)
 ## Turn into folder note for "{folderName}"
-This command will attach the file to the folder it's in. For example file "test" that is in the folder "test2" will be the new folder note for the folder "test2".
+This command will attach the file to the folder it's in. For example file "test" that is in the folder "test2" will be the new folder note for the folder "test2".
+
+![Example type:video](../assets/videos/Obsidian_bUlTDSG9a9.mp4)

docs/docs/Features/Folder context menu commands.md

@@ -1,10 +1,14 @@
 # Folder context menu commands
 
+
 ## Exclude folder from folder notes
 This will add the folder to the excluded folder list. [Click here to find more about excluded folders out.](Exclude%20folders.md)
 ## Create {type} folder note
 This command will create a folder note of the file type you selected and depending on your settings the folder note will be in the folder itself or in the parent folder of the folder.
 ## Delete folder note
-The folder note from the folder you clicked on gets deleted.
+The folder note from the folder you clicked on gets deleted. (Only the file and note the folder itself)
 ## Open folder note
-Opens folder notes in the currently active tab or if you have the setting "open folder note in a new tab by default" enabled the note opens in a new tab.
+Opens folder notes in the currently active tab or if you have the setting "open folder note in a new tab by default" enabled the note opens in a new tab.
+
+## Copy Obsidian URL
+Copies the Obsidian URL of the file which is linked to the folder and it can be used in other programs to directly open the file.

docs/docs/Features/Settings/File explorer.md

@@ -0,0 +1,32 @@
+# File explorer settings
+### Hide folder note
+Hide files in the file explorer which are linked to folders
+### Disable click-to-open folder note on mobile
+Disable the option to open folder notes by tapping on the folder name of a folder with a folder note in the file explorer. With that option enabled it's only possible to open folder notes with the command palette oder the context menu.
+
+### Open folder notes by only clicking directly on the folder name
+With this option enabled you can only open a folder note by clicking when doing so exactly on the folder name and not on the whitespace around it. When you also have "Disable folder collapsing" enabled folders also won't collapse when you click on a folder name.
+
+### Disable folder collapsing
+Stop folders with folder notes from collapsing when click directly on the folder name or on the whitespace around it. Except when you click on the collapse icon you can still collapse folders.
+
+### Use submenus
+When this option is enabled and you use the context menu for folder/files at first you can only see "Folder Note Commands" in the menu and you have to hover over it to see all options.
+
+## Style settings
+
+### Highlight folder in the file explorer
+Normally only the file gets highlighted in the explorer but when you enable this option the folder of a folder note gets also highlighted.
+
+### Hide collapse icon
+Hide the collapse icon next to a folder name for a folder with a folder note or also for every folder with no files.
+
+### Underline the name of folder note
+Underline the names of folders with folder notes in the file explorer.
+
+### Bold the name of folder notes
+Bold folders in the file explorer that have a folder note.
+
+### Cursive the name of folder notes
+Make folder with folder notes in the file explorer cursive.
+

docs/docs/Features/Settings/General.md

@@ -0,0 +1,29 @@
+# General settings
+### Folder note name template
+The entered text is going to be the name of all folder notes and when file name matches this text it becomes a folder note. {{folder_name}} is a placeholder for the name of the folder linked to the file. If you change the text every existing folder note which matched the old text won't be a folder note anymore and you have to use the button "Rename existing folder notes" to rename all folder notes.
+
+### Supported file types
+Only the file types you select will be selected will be recognized as folder notes. This means you that a file that matches the name of a folder and normally would be a folder note but has an extension that isn't included in the supported file types list won't be a folder note and you can't open it by click on the folder name.
+
+### Template path
+When you don't have templater installed & enabled you can choose any file in your vault as a template. But if you have templater enabled you first have to choose the folder where your templates are located, in the settings of the templater plugin. You can also use the core templates plugin for applying templates to new folder notes.
+
+### Storage location
+Choose if the folder notes should be stored in the folder they're linked to or in the parent folder of the folder they're linked to. If you switch the storage method all existing folder won't be recognized as folder notes anymore until you click on the switch button and the location of old folder note files gets changed.
+
+## Folder note behavior
+### Confirm folder note deletion
+When enabled a modal pops up when you try to delete folder note using the context menu.
+### Open folder note in a new tab by default
+When enabled every folder note opens in a new tab unless it is already open in the currently focused file in the editor and if the subsetting "focus existing tab instead of creating a new one" is also enabled every folder note only has one tab open. If you have different tab open than of a folder note you want to open and the folder note already has a tab open it'll switch to it.
+
+## Integration & Compatibility
+### Enable [front matter title plugin](https://github.com/snezhig/obsidian-front-matter-title) integration
+Applies the changes made to the files names in the frontmatter also to the folder names in the file explorer & the path for folders with folder notes. This is also requires to enable the auto update setting in the file explorer & path settings of the folder notes plugin.
+
+## Session & Persistence
+
+### Persist tab after restart
+Open the same tab you had open in the plugin settings before restarting Obsidian.
+### Persist tab during session only
+Open the same tab after closing the plugin settings and opening it again but if "Persist tab after restart" is disabled it won't open the same tab again after restarting Obsidian.

docs/docs/Features/Settings/Path.md

@@ -0,0 +1,22 @@
+# Path settings
+The "path" is the file path above a note in the editor.
+
+![Screenshot](../../assets/screenshots/Obsidian_LaoyRX8jr2.png)
+### Open folder note through path
+Open a folder note by click on a folder name in the path when it has a folder note linked to it.
+
+### Open sidebar when opening a folder note through path
+Disable/enable if the left sidebar should also open when you open a folder note through the path.
+
+### Auto update folder name in the path ([front matter title plugin only](https://github.com/snezhig/obsidian-front-matter-title))
+Automatically update the folder name in the path when the front matter title plugin is enabled and the title for a folder note is changed in the front matter. This will not change the file name, only the displayed name in the path.
+
+## Style settings
+
+### Underline folder in the path
+Underline every folder with a folder note in the path.
+
+### Bold folders in the path
+Bold every folder with a folder note in the path.
+### Cursive folders in the path
+Make every folder with a folder note in the path cursive.

docs/docs/Folder overview.md

@@ -1,4 +1,6 @@
 # Folder overview
+[The folder overview feature can be installed as a standalone plugin and works without the folder notes plugin by clicking on this.](https://obsidian.md/plugins?id=folder-overview)
+
 This feature/plugin creates a [code block](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Code+blocks) that provides an overview of your entire vault or specific folders. Instructions for creating or editing a folder overview, along with additional guidance, can be found further down the page.
 Currently there are two styles available: **file explorer** & **list style**, with more coming soon. The **overview updates** itself **automatically** when you create, delete or modify a file. You can also integrate it into **templates**, as explained further down below this page.
 
@@ -20,3 +22,10 @@ To edit the default values for new folder overviews you can either use the comma
 ![Screenshot](../assets/screenshots/b4QOtkzJs0.png)
 (On the left is the plugin settings tab and the right the view you see when you use the "Edit folder overview" command)
 
+## How can I use this in a template?
+
+Just create the folder overview as normal in a template and then change the settings to be what you want to use as a default for the files you apply the templates to. It also doesn't matter that the id of the overview in the template will be the same as the id of the overview that gets created when the template has been used.
+
+## What's the id in the code block for?
+They're there to differentiate the overviews from each other so that you can use "Edit folder overview" command to edit the overviews from one file (there can be multiple overviews in one file). It's especially useful on mobile because the button to edit the code block on mobile is quite small.
+

docs/docs/Getting started.md

@@ -3,20 +3,6 @@
 ## How to install the plugin
 The plugin can be downloaded by clicking on [https://obsidian.md/plugins?id=folder-notes](https://obsidian.md/plugins?id=folder-notes) and then on install.
 ## Basic features 
-### Create folder overview
-Find more out about the folder overview feature on the [folder overview page](./Folder%20overview.md)
-
-To create a folder overview in a note either use the command "Insert folder overview" or on pc right click and select "create folder overview"
-
-![Context menu](./assets/VyBTGhA5eJAVVFusZXIz.png){: style="max-width: 40%;max-height: 40%"}
-
-The folder overview with the default settings looks like this with one note
-
-![Folder overview](./assets/u6ccTTzVbwzBivySFacZ.png)
-
-To edit the folder overview click on the little icon on the right that is shown when hovering over the codeblock
-
-![Folder overview settings](./assets/2wzCXFTpD2.gif)
 
 ### Create folder note
 
@@ -30,7 +16,7 @@ On PC either use ctrl or strg (depending on your settings) and then click on a f
 
 Open the [command palette](https://help.obsidian.md/Plugins/Command+palette) and then type "folder notes" and select the command you need.
 
-![Command palette](./assets/FKhiQZLm4Juu4VdFTxPC.png)
+![Command palette](./assets/screenshots/Obsidian_3VEQ3kOT4S.png)
 
 ### Open folder note
 
@@ -44,7 +30,17 @@ The second option is to open one file of the files from the folder from which yo
 
 The last option and the option that is only available to desktop users is to use alt or ctrl and click on the folder name. When you don't hold ctrl/alt and click on a folder name the folder gets collapsed as normal. To use this option you first have to enable it in the plugin settings under the tab general.
 
-![Settings page](./assets/2KHZfsNVuJL8dIz6cTF5.png)
+![Settings page](./assets/screenshots/Obsidian_7B8zdp5xDh.png)
 
+### Create folder overview
+Find more out about the folder overview feature on the [folder overview page](./Folder%20overview.md)
 
+To create a folder overview in a note either use the command "Insert folder overview" or on pc right click and select "create folder overview"
+
+![Context menu](./assets/VyBTGhA5eJAVVFusZXIz.png){: style="max-width: 40%;max-height: 40%"}
+
+The folder overview with the default settings looks like this with one note
+
+![Folder overview](./assets/u6ccTTzVbwzBivySFacZ.png)
+To find out how to edit the folder overview have a look at [folder overview page](./Folder%20overview.md)
 

docs/docs/Troubleshooting.md

@@ -0,0 +1,7 @@
+# Troubleshooting
+## Folder with folder note still collapses
+Issue: You've "Disable folder collapsing" enabled, click on a folder name that has folder note linked to it and it still collapses.
+
+Possible cause & solution: You've "auto-reveal current file" enabled and need to disable it in order to make this feature work.
+
+![Auto-reveal current file](../assets/screenshots/Obsidian_K3ph5zw0mq.png)

docs/docs/index.md

@@ -1,30 +1,32 @@
 # Overview
-Folder notes is a plugin for the note taking app  [Obsidian](https://obsidian.md/) that lets you attach notes to folders so that you can click on the name of a folder to open the note like in the app [Notion](https://www.notion.so/).
-This plugin has some unique features that separate it from similar "Folder note" plugins like opening folder notes through the path, creating folder notes for every existing folder, templater/template support and more.
-## Features
-- Open folder notes through the file explorer/path by clicking on folder names
-- Only open folder notes through alt or ctrl + mouse click
-- Excalidraw, Canvas, ... folder notes unlimited file type folder notes
-- Sync folder note name with the folder name
-- Automatically create folder notes when creating folders
-- Turn every folder into a folder note
-- Folder overview code block with default settings in settings from the plugin
-- Hide folder notes in the file explorer
-- Underline, bold and cursive folder names in the file explorer/path option
-- Stop collapsing of folders (with folder notes) in the file explorer
-- Only open folder note through the folder name and the rest collapses the folder
-- Front matter title plugin support
-- Exclude folders with regex, path and a pattern with \*
+Folder Notes is a plugin for the note-taking app [Obsidian](https://obsidian.md/) that allows you to attach notes directly to folders. This lets you open a note by clicking on a folder name—similar to the functionality found in [Notion](https://www.notion.so/).
+
+Unlike other “folder note” plugins, Folder Notes offers several unique features, including support for custom file types, templating, and advanced folder handling options.
+
 ## Get started 
 
-Read the [Getting started page](Getting%20started.md) for further details.
+Read the [Getting started page](Getting%20started.md) for further details and the pages under the "Features" category explain every feature in detail.
+## Features
+- Open folder notes by clicking folder names in the file explorer or path
+- Optional modifier key (Alt or Ctrl + click) to open folder notes
+- Full support for any file type as folder notes (e.g., Excalidraw, Canvas, etc.)
+- Automatically sync folder note names with their folder names
+- Auto-create a folder note when a new folder is created
+- Convert all existing folders into folder notes
+- Use a folder-overview code block with configurable default settings
+- Option to hide folder notes from the file explorer
+- Style folder names (underline, bold, italic) in the file explorer or path
+- Prevent automatic collapsing of folders that have folder notes
+- Choose to only open the folder note when clicking the folder name; other clicks collapse the folder
+- Front matter title plugin support
+- Exclude specific folders using regex, path, or wildcard patterns (`*`)
 
 ## Credits
 Thank you to everyone who has created a plugin that inspired me and I took code from.
 - Template suggester, created by [SilentVoid13](https://github.com/SilentVoid13) and [Liamcain](https://github.com/liamcain) (their plugins: [Templater](https://github.com/SilentVoid13/Templater/), [Periodic notes](https://github.com/liamcain/obsidian-periodic-notes))
 - Apply template to note, first seen in [https://github.com/mgmeyers/obsidian-kanban/](https://github.com/mgmeyers/obsidian-kanban/) from [Mgmeyers](https://github.com/mgmeyers)
 - Folder underline, inspired from [https://github.com/aidenlx/alx-folder-note](https://github.com/aidenlx/alx-folder-note)
-- Stop folders from collapsing, the basic idea from [https://github.com/alangrainger/obsidian-folder-notes](https://github.com/alangrainger/obsidian-folder-notes) and some code lines
+- Stop folders from collapsing, the basic idea from [https://github.com/alangrainger/obsidian-folder-notes](https://github.com/alangrainger/obsidian-folder-notes)
 - The basic idea is from [https://github.com/xpgo/obsidian-folder-note-plugin](https://github.com/xpgo/obsidian-folder-note-plugin)
 
 ## Support the development of the plugin

docs/mkdocs.yml

@@ -2,6 +2,8 @@ site_name: Obsidian folder notes
 theme:
   name: material
   logo: assets/2023_Obsidian_logo.svg.png
+  features:
+    - navigation.expand
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default

manifest-beta.json

@@ -1,7 +1,7 @@
 {
   "id": "folder-notes",
   "name": "Folder notes beta",
-  "version": "1.8.1-2-beta",
+  "version": "1.8.5-3-beta",
   "minAppVersion": "0.15.0",
   "description": "Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.",
   "author": "Lost Paul",