Skip to content

Commit

Permalink
Extended the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
LostPaul committed Jan 3, 2024
1 parent 019a9ee commit 01aad39
Show file tree
Hide file tree
Showing 13 changed files with 84 additions and 8 deletions.
16 changes: 16 additions & 0 deletions docs/docs/Features/Command palette commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Command palette commands

## Make current active note a folder note for the folder of the active note
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
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 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.
## 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
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.
33 changes: 33 additions & 0 deletions docs/docs/Features/Exclude folders.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Exclude folders
The exclude folder feature can be found in the plugin settings under the tab "Exclude folders".
## 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.
### 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)
### 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).

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.

For example this regex matches every folder in the file explorer.
![Screenshot](../assets/xUo6aJuIiABXaPl7eosX.png)

When we use * to match a folder it only works when it's at the start or at the end of a string or both.
For example when we use the folder name "Test" and the following patterns we get this:

\*est => matches the name
Test* => matches the name
\*es\* => matches the name
\*Test\* => matches the name
\*Test 2\* => doesn't match the name
## How to change the settings
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".
6 changes: 6 additions & 0 deletions docs/docs/Features/File context menu commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# File commands

## 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.
## 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".
10 changes: 10 additions & 0 deletions docs/docs/Features/Folder context menu commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Folder 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.
## 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.
14 changes: 14 additions & 0 deletions docs/docs/Features/Folder overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Folder overview

## Create overview
There are two options to create a folder overview in a note
- Use the command "Insert folder overview" from the [command palette](https://help.obsidian.md/Plugins/Command+palette)
- On desktop right click and click on the option "Create folder overview"
## Edit overview
If the overview shows no files or folders yet you can just click on the button that says "Edit overview". But if there are already files/folders it's a bit more complicated than the button and to then edit the overview you have to hover over the overview and click on the "Edit this block" button on the right top corner of the overview with only an icon.

The video below shows the steps explained in the text.
![Video](../assets/n5AGi3VCxF5JcNx2Wm5O.mp4)
## Default settings
To edit the settings for a new folder overview that hasn't been created yet you have to open the plugin settings and go to the folder overview tab and click on the manage button.
![Screenshot](../assets/ngkJjEcxUUTkX6eB4mSs.png)
5 changes: 0 additions & 5 deletions docs/docs/Getting started.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Getting started

## 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](./Features/Folder%20overview.md)

To create a folder overview in a note either use the command "Insert folder overview" or right click on pc and select "create folder overview"
Expand Down
Binary file added docs/docs/assets/mbZW1SXv8o3fKU4g8j3V.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/n5AGi3VCxF5JcNx2Wm5O.mp4
Binary file not shown.
Binary file added docs/docs/assets/ngkJjEcxUUTkX6eB4mSs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/xUo6aJuIiABXaPl7eosX.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/assets/xdS3VV7wjIRFNHADE0lx.mp4
Binary file not shown.
7 changes: 4 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,18 @@ Folder notes is a plugin for the note taking app [Obsidian](https://obsidian.md
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
- Canvas folder notes (soon support for Excalidraw and more)
- 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 folder names in the file explorer/path
- 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 \*
## Get started

Read the [Getting started page](Getting%20started.md) for further details.
Expand Down
1 change: 1 addition & 0 deletions src/Commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ export class Commands {
},
})
}

fileCommands() {
this.plugin.registerEvent(this.app.workspace.on('file-menu', (menu: Menu, file: TAbstractFile) => {
let folder: TAbstractFile | TFolder | null = file.parent;
Expand Down

0 comments on commit 01aad39

Please sign in to comment.